<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.10"/>
<title>osd: Osd_v4_0</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.gif"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">osd
   </div>
   <div id="projectbrief">Xilinx SDK Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.10 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">Osd_v4_0</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_osd___config.html">XOsd_Config</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_osd___layer.html">XOsd_Layer</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_osd.html">XOsd</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:gae6e41c067d999ee6cdc29d3868ec8be8"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osd__v4__0.html#gae6e41c067d999ee6cdc29d3868ec8be8">XOsd_Enable</a>(InstancePtr)</td></tr>
<tr class="separator:gae6e41c067d999ee6cdc29d3868ec8be8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2a84453f73f690e671aa3b2ede645fb0"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osd__v4__0.html#ga2a84453f73f690e671aa3b2ede645fb0">XOsd_Disable</a>(InstancePtr)</td></tr>
<tr class="separator:ga2a84453f73f690e671aa3b2ede645fb0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gace1507486db80db018b62df611dbe0d6"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osd__v4__0.html#gace1507486db80db018b62df611dbe0d6">XOsd_RegUpdateEnable</a>(InstancePtr)</td></tr>
<tr class="separator:gace1507486db80db018b62df611dbe0d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gacf3d6dd9a30650e586a89cbbfa2f0e1a"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osd__v4__0.html#gacf3d6dd9a30650e586a89cbbfa2f0e1a">XOsd_RegUpdateDisable</a>(InstancePtr)</td></tr>
<tr class="separator:gacf3d6dd9a30650e586a89cbbfa2f0e1a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2ccc3d88129121707113a37dd1a7dea8"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osd__v4__0.html#ga2ccc3d88129121707113a37dd1a7dea8">XOsd_Reset</a>(InstancePtr)</td></tr>
<tr class="separator:ga2ccc3d88129121707113a37dd1a7dea8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac752c2e2d84d0735f45986c2a27df3b2"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osd__v4__0.html#gac752c2e2d84d0735f45986c2a27df3b2">XOsd_IntrEnable</a>(InstancePtr,  IntrType)</td></tr>
<tr class="separator:gac752c2e2d84d0735f45986c2a27df3b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga53d9596240b76f8887fd519518f21e82"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osd__v4__0.html#ga53d9596240b76f8887fd519518f21e82">XOsd_IntrDisable</a>(InstancePtr,  IntrType)</td></tr>
<tr class="separator:ga53d9596240b76f8887fd519518f21e82"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga89fd83e071e7da016c89f9e155f1453a"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osd__v4__0.html#ga89fd83e071e7da016c89f9e155f1453a">XOsd_IntrGetPending</a>(InstancePtr)</td></tr>
<tr class="separator:ga89fd83e071e7da016c89f9e155f1453a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2507152f445947e19e16ac59939adc9e"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osd__v4__0.html#ga2507152f445947e19e16ac59939adc9e">XOsd_IntrClear</a>(InstancePtr,  IntrType)</td></tr>
<tr class="separator:ga2507152f445947e19e16ac59939adc9e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2e2425a5c7b56573e9fdc833f89843f0"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osd__v4__0.html#ga2e2425a5c7b56573e9fdc833f89843f0">XOsd_StatusGetPending</a>(InstancePtr)</td></tr>
<tr class="separator:ga2e2425a5c7b56573e9fdc833f89843f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3a758a90dded736022ab70e7c0be8796"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osd__v4__0.html#ga3a758a90dded736022ab70e7c0be8796">XOsd_SyncReset</a>(InstancePtr)</td></tr>
<tr class="separator:ga3a758a90dded736022ab70e7c0be8796"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gabaa8b4a92fcfc0ae2152c87249975db9"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osd__v4__0.html#gabaa8b4a92fcfc0ae2152c87249975db9">XOsd_FSyncReset</a>&#160;&#160;&#160;<a class="el" href="group__osd__v4__0.html#ga3a758a90dded736022ab70e7c0be8796">XOsd_SyncReset</a></td></tr>
<tr class="separator:gabaa8b4a92fcfc0ae2152c87249975db9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga44aa3036799de8b96c61143abf156b02"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osd__v4__0.html#ga44aa3036799de8b96c61143abf156b02">XOsd_Start</a>&#160;&#160;&#160;<a class="el" href="group__osd__v4__0.html#gae6e41c067d999ee6cdc29d3868ec8be8">XOsd_Enable</a></td></tr>
<tr class="separator:ga44aa3036799de8b96c61143abf156b02"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9e08f021a97bc835d659b08b57dc4b5a"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osd__v4__0.html#ga9e08f021a97bc835d659b08b57dc4b5a">XOsd_Stop</a>&#160;&#160;&#160;<a class="el" href="group__osd__v4__0.html#ga2a84453f73f690e671aa3b2ede645fb0">XOsd_Disable</a></td></tr>
<tr class="separator:ga9e08f021a97bc835d659b08b57dc4b5a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga51a9fc13b8a6a270b1a1c531f54dcd8a"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osd__v4__0.html#ga51a9fc13b8a6a270b1a1c531f54dcd8a">XOSD_HW_H_</a></td></tr>
<tr class="separator:ga51a9fc13b8a6a270b1a1c531f54dcd8a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:gab6e55293af64ef50112d468e2b327c93"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osd__v4__0.html#gab6e55293af64ef50112d468e2b327c93">XOsd_CallBack</a>) (void *CallBackRef)</td></tr>
<tr class="separator:gab6e55293af64ef50112d468e2b327c93"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae4470e2d494f46907e1b2602a5b04d0b"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osd__v4__0.html#gae4470e2d494f46907e1b2602a5b04d0b">XOsd_ErrorCallBack</a>) (void *CallBackRef, u32 ErrorMask)</td></tr>
<tr class="separator:gae4470e2d494f46907e1b2602a5b04d0b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gaf9dad59565307cd8f71b385689f91048"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osd__v4__0.html#gaf9dad59565307cd8f71b385689f91048">XOsd_CfgInitialize</a> (<a class="el" href="struct_x_osd.html">XOsd</a> *InstancePtr, <a class="el" href="struct_x_osd___config.html">XOsd_Config</a> *CfgPtr, u32 EffectiveAddr)</td></tr>
<tr class="separator:gaf9dad59565307cd8f71b385689f91048"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga037810c3a4ef79dba6cc202afc679373"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osd__v4__0.html#ga037810c3a4ef79dba6cc202afc679373">XOsd_SetActiveSize</a> (<a class="el" href="struct_x_osd.html">XOsd</a> *InstancePtr, u32 Width, u32 Height)</td></tr>
<tr class="separator:ga037810c3a4ef79dba6cc202afc679373"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gafad06669f4df698b225bfe8b05e6dbbd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osd__v4__0.html#gafad06669f4df698b225bfe8b05e6dbbd">XOsd_GetActiveSize</a> (<a class="el" href="struct_x_osd.html">XOsd</a> *InstancePtr, u32 *WidthPtr, u32 *HeightPtr)</td></tr>
<tr class="separator:gafad06669f4df698b225bfe8b05e6dbbd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab2040236e554455aa030814966dad413"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osd__v4__0.html#gab2040236e554455aa030814966dad413">XOsd_SetBackgroundColor</a> (<a class="el" href="struct_x_osd.html">XOsd</a> *InstancePtr, u16 Red, u16 Blue, u16 Green)</td></tr>
<tr class="separator:gab2040236e554455aa030814966dad413"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa7361c792b36dafe0e48ae22c32cf125"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osd__v4__0.html#gaa7361c792b36dafe0e48ae22c32cf125">XOsd_GetBackgroundColor</a> (<a class="el" href="struct_x_osd.html">XOsd</a> *InstancePtr, u16 *RedPtr, u16 *BluePtr, u16 *GreenPtr)</td></tr>
<tr class="separator:gaa7361c792b36dafe0e48ae22c32cf125"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga33679ac417b6f2596c6b6b085d39a5b1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osd__v4__0.html#ga33679ac417b6f2596c6b6b085d39a5b1">XOsd_SetLayerDimension</a> (<a class="el" href="struct_x_osd.html">XOsd</a> *InstancePtr, u8 LayerIndex, u16 XStart, u16 YStart, u16 XSize, u16 YSize)</td></tr>
<tr class="separator:ga33679ac417b6f2596c6b6b085d39a5b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3223d1726b2e25cda7de089d85353c1b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osd__v4__0.html#ga3223d1726b2e25cda7de089d85353c1b">XOsd_GetLayerDimension</a> (<a class="el" href="struct_x_osd.html">XOsd</a> *InstancePtr, u8 LayerIndex, u16 *XStartPtr, u16 *YStartPtr, u16 *XSizePtr, u16 *YSizePtr)</td></tr>
<tr class="separator:ga3223d1726b2e25cda7de089d85353c1b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga08b6809a1bd0d27dd275e06fe1cbea61"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osd__v4__0.html#ga08b6809a1bd0d27dd275e06fe1cbea61">XOsd_SetLayerAlpha</a> (<a class="el" href="struct_x_osd.html">XOsd</a> *InstancePtr, u8 LayerIndex, u16 GlobalAlphaEnable, u16 GlobalAlphaValue)</td></tr>
<tr class="separator:ga08b6809a1bd0d27dd275e06fe1cbea61"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab692eaddc144c270dfb05f7171c403e2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osd__v4__0.html#gab692eaddc144c270dfb05f7171c403e2">XOsd_GetLayerAlpha</a> (<a class="el" href="struct_x_osd.html">XOsd</a> *InstancePtr, u8 LayerIndex, u16 *GlobalAlphaEnablePtr, u16 *GlobalAlphaValuePtr)</td></tr>
<tr class="separator:gab692eaddc144c270dfb05f7171c403e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae10e5b163cf71fd385200b724d1dd560"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osd__v4__0.html#gae10e5b163cf71fd385200b724d1dd560">XOsd_SetLayerPriority</a> (<a class="el" href="struct_x_osd.html">XOsd</a> *InstancePtr, u8 LayerIndex, u8 Priority)</td></tr>
<tr class="separator:gae10e5b163cf71fd385200b724d1dd560"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga02cbaaa4f5e6b640c876b727db267602"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osd__v4__0.html#ga02cbaaa4f5e6b640c876b727db267602">XOsd_GetLayerPriority</a> (<a class="el" href="struct_x_osd.html">XOsd</a> *InstancePtr, u8 LayerIndex, u8 *PriorityPtr)</td></tr>
<tr class="separator:ga02cbaaa4f5e6b640c876b727db267602"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gacdb4b75859dbfc611d70382fb2c94a7f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osd__v4__0.html#gacdb4b75859dbfc611d70382fb2c94a7f">XOsd_EnableLayer</a> (<a class="el" href="struct_x_osd.html">XOsd</a> *InstancePtr, u8 LayerIndex)</td></tr>
<tr class="separator:gacdb4b75859dbfc611d70382fb2c94a7f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1ecd1900b797b12867274e0daf1a8d62"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osd__v4__0.html#ga1ecd1900b797b12867274e0daf1a8d62">XOsd_DisableLayer</a> (<a class="el" href="struct_x_osd.html">XOsd</a> *InstancePtr, u8 LayerIndex)</td></tr>
<tr class="separator:ga1ecd1900b797b12867274e0daf1a8d62"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9d28c4453d039dc09b540d55c78c80b2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osd__v4__0.html#ga9d28c4453d039dc09b540d55c78c80b2">XOsd_LoadColorLUTBank</a> (<a class="el" href="struct_x_osd.html">XOsd</a> *InstancePtr, u8 GcIndex, u8 BankIndex, u32 ColorData[])</td></tr>
<tr class="separator:ga9d28c4453d039dc09b540d55c78c80b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6579cb01322e477e72faec9ea6feee63"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osd__v4__0.html#ga6579cb01322e477e72faec9ea6feee63">XOsd_LoadCharacterSetBank</a> (<a class="el" href="struct_x_osd.html">XOsd</a> *InstancePtr, u8 GcIndex, u8 BankIndex, u32 CharSetData[])</td></tr>
<tr class="separator:ga6579cb01322e477e72faec9ea6feee63"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5a76210dc91d4a51111855bbc501c4e8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osd__v4__0.html#ga5a76210dc91d4a51111855bbc501c4e8">XOsd_LoadTextBank</a> (<a class="el" href="struct_x_osd.html">XOsd</a> *InstancePtr, u8 GcIndex, u8 BankIndex, u32 TextData[])</td></tr>
<tr class="separator:ga5a76210dc91d4a51111855bbc501c4e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5552532bfdfcd272722180e71d6c7b75"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osd__v4__0.html#ga5552532bfdfcd272722180e71d6c7b75">XOsd_SetActiveBank</a> (<a class="el" href="struct_x_osd.html">XOsd</a> *InstancePtr, u8 GcIndex, u8 ColorBankIndex, u8 CharBankIndex, u8 TextBankIndex, u8 InstructionBankIndex)</td></tr>
<tr class="separator:ga5552532bfdfcd272722180e71d6c7b75"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7abff2415587a54c259f159fc780e2cc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osd__v4__0.html#ga7abff2415587a54c259f159fc780e2cc">XOsd_CreateInstruction</a> (<a class="el" href="struct_x_osd.html">XOsd</a> *InstancePtr, u32 InstructionPtr[], u8 GcIndex, u16 ObjType, u8 ObjSize, u16 XStart, u16 YStart, u16 XEnd, u16 YEnd, u8 TextIndex, u8 ColorIndex)</td></tr>
<tr class="separator:ga7abff2415587a54c259f159fc780e2cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga55937cb3259f5843c9e1beec4e126955"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osd__v4__0.html#ga55937cb3259f5843c9e1beec4e126955">XOsd_LoadInstructionList</a> (<a class="el" href="struct_x_osd.html">XOsd</a> *InstancePtr, u8 GcIndex, u8 BankIndex, u32 InstSetPtr[], u32 InstNum)</td></tr>
<tr class="separator:ga55937cb3259f5843c9e1beec4e126955"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga94b9d7eac70a2fc2315b07059e832986"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osd__v4__0.html#ga94b9d7eac70a2fc2315b07059e832986">XOsd_GetVersion</a> (<a class="el" href="struct_x_osd.html">XOsd</a> *InstancePtr)</td></tr>
<tr class="separator:ga94b9d7eac70a2fc2315b07059e832986"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga282d133b39cea1c09ee62a086f8eeee8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_x_osd___config.html">XOsd_Config</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osd__v4__0.html#ga282d133b39cea1c09ee62a086f8eeee8">XOsd_LookupConfig</a> (u16 DeviceId)</td></tr>
<tr class="separator:ga282d133b39cea1c09ee62a086f8eeee8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7079d6f5586ca603657dac6b9e188105"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osd__v4__0.html#ga7079d6f5586ca603657dac6b9e188105">XOsd_IntrHandler</a> (void *InstancePtr)</td></tr>
<tr class="separator:ga7079d6f5586ca603657dac6b9e188105"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3d389873d919422ef5f5d56592659481"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osd__v4__0.html#ga3d389873d919422ef5f5d56592659481">XOsd_SetCallBack</a> (<a class="el" href="struct_x_osd.html">XOsd</a> *InstancePtr, u32 HandlerType, void *CallBackFunc, void *CallBackRef)</td></tr>
<tr class="separator:ga3d389873d919422ef5f5d56592659481"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8a5fad0300d0413161f50c5df445a08f"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osd__v4__0.html#ga8a5fad0300d0413161f50c5df445a08f">XOsd_SelfTest</a> (<a class="el" href="struct_x_osd.html">XOsd</a> *InstancePtr)</td></tr>
<tr class="separator:ga8a5fad0300d0413161f50c5df445a08f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
Register Offsets</h2></td></tr>
<tr class="memitem:ga391290622b578053a6e4f87b94afe6d2"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osd__v4__0.html#ga391290622b578053a6e4f87b94afe6d2">XOSD_ISR_OFFSET</a>&#160;&#160;&#160;<a class="el" href="group__osd__v4__0.html#gaee8b66db164a6929f9d75c1e75b6c4f7">XOSD_STATUS_OFFSET</a></td></tr>
<tr class="separator:ga391290622b578053a6e4f87b94afe6d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
Core register I/O APIs</h2></td></tr>
<tr class="memitem:ga09c0fe42f0cb0fe4a84e84acb6d548f3"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osd__v4__0.html#ga09c0fe42f0cb0fe4a84e84acb6d548f3">XOsd_ReadReg</a>(BaseAddress,  RegOffset)&#160;&#160;&#160;XOsd_In32((BaseAddress) + (u32)(RegOffset))</td></tr>
<tr class="separator:ga09c0fe42f0cb0fe4a84e84acb6d548f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga37791d01d7ba72baa57bd45c2744a6b7"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osd__v4__0.html#ga37791d01d7ba72baa57bd45c2744a6b7">XOsd_WriteReg</a>(BaseAddress,  RegOffset,  Data)&#160;&#160;&#160;XOsd_Out32((BaseAddress) + (u32)(RegOffset), (Data))</td></tr>
<tr class="separator:ga37791d01d7ba72baa57bd45c2744a6b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="gade3687044261450fc11f800ce9414a02"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_ACTIVE_SIZE_OFFSET&#160;&#160;&#160;0x020</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Screen Size / Output Active_Size Offset. </p>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#gafad06669f4df698b225bfe8b05e6dbbd">XOsd_GetActiveSize()</a>, and <a class="el" href="group__osd__v4__0.html#ga037810c3a4ef79dba6cc202afc679373">XOsd_SetActiveSize()</a>.</p>

</div>
</div>
<a class="anchor" id="gac75b658316a6744fba822b9d19cdbd96"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_ACTSIZE_NUM_LINE_MASK&#160;&#160;&#160;0x0FFF0000</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Vertical Height of OSD Output Mask. </p>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#gafad06669f4df698b225bfe8b05e6dbbd">XOsd_GetActiveSize()</a>, and <a class="el" href="group__osd__v4__0.html#ga037810c3a4ef79dba6cc202afc679373">XOsd_SetActiveSize()</a>.</p>

</div>
</div>
<a class="anchor" id="ga9ac4754b89e00ebaa197523d94c5abab"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_ACTSIZE_NUM_LINE_SHIFT&#160;&#160;&#160;16</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Vertical Height of OSD Output Shift. </p>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#gafad06669f4df698b225bfe8b05e6dbbd">XOsd_GetActiveSize()</a>, and <a class="el" href="group__osd__v4__0.html#ga037810c3a4ef79dba6cc202afc679373">XOsd_SetActiveSize()</a>.</p>

</div>
</div>
<a class="anchor" id="gaee78e03170b5d597abcdb41bb789987a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_ACTSIZE_NUM_PIXEL_MASK&#160;&#160;&#160;0x00000FFF</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Horizontal Width of OSD Output Mask. </p>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#gafad06669f4df698b225bfe8b05e6dbbd">XOsd_GetActiveSize()</a>, and <a class="el" href="group__osd__v4__0.html#ga037810c3a4ef79dba6cc202afc679373">XOsd_SetActiveSize()</a>.</p>

</div>
</div>
<a class="anchor" id="ga05c21ad0e43e61c2a4a904d60ff59a0f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_BC0_OFFSET&#160;&#160;&#160;0x100</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Background Color Channel 0 Offset. </p>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#gaa7361c792b36dafe0e48ae22c32cf125">XOsd_GetBackgroundColor()</a>, and <a class="el" href="group__osd__v4__0.html#gab2040236e554455aa030814966dad413">XOsd_SetBackgroundColor()</a>.</p>

</div>
</div>
<a class="anchor" id="ga636eaade937285fa383032f1013e4007"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_BC0_YG_MASK&#160;&#160;&#160;0x00000FFF</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Y (luma) or Green Mask. </p>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#gaa7361c792b36dafe0e48ae22c32cf125">XOsd_GetBackgroundColor()</a>, and <a class="el" href="group__osd__v4__0.html#gab2040236e554455aa030814966dad413">XOsd_SetBackgroundColor()</a>.</p>

</div>
</div>
<a class="anchor" id="gaf595fa566ff6e43a0b68207b87ae934b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_BC1_OFFSET&#160;&#160;&#160;0x104</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Background Color Channel 1 Offset. </p>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#gaa7361c792b36dafe0e48ae22c32cf125">XOsd_GetBackgroundColor()</a>, and <a class="el" href="group__osd__v4__0.html#gab2040236e554455aa030814966dad413">XOsd_SetBackgroundColor()</a>.</p>

</div>
</div>
<a class="anchor" id="gadbc74a40e404c4500625c304f6038eb8"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_BC1_UCBB_MASK&#160;&#160;&#160;0x00000FFF</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>U (Cb) or Blue Mask. </p>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#gaa7361c792b36dafe0e48ae22c32cf125">XOsd_GetBackgroundColor()</a>, and <a class="el" href="group__osd__v4__0.html#gab2040236e554455aa030814966dad413">XOsd_SetBackgroundColor()</a>.</p>

</div>
</div>
<a class="anchor" id="ga9196d5680140ee807654c6cfc14f8319"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_BC2_OFFSET&#160;&#160;&#160;0x108</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Background Color Channel 2 Offset. </p>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#gaa7361c792b36dafe0e48ae22c32cf125">XOsd_GetBackgroundColor()</a>, and <a class="el" href="group__osd__v4__0.html#gab2040236e554455aa030814966dad413">XOsd_SetBackgroundColor()</a>.</p>

</div>
</div>
<a class="anchor" id="ga5ea983e4b594d372821939b55c4f1ec3"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_BC2_VCRR_MASK&#160;&#160;&#160;0x00000FFF</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>V(Cr) or Red Mask. </p>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#gaa7361c792b36dafe0e48ae22c32cf125">XOsd_GetBackgroundColor()</a>, and <a class="el" href="group__osd__v4__0.html#gab2040236e554455aa030814966dad413">XOsd_SetBackgroundColor()</a>.</p>

</div>
</div>
<a class="anchor" id="ga02df75e48788b9182ef56cfa94cccdd4"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_COLOR_ENTRY_SIZE&#160;&#160;&#160;4</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Size of each color entry in bytes. </p>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#ga9d28c4453d039dc09b540d55c78c80b2">XOsd_LoadColorLUTBank()</a>.</p>

</div>
</div>
<a class="anchor" id="gaf80d798ea9734a4c56e7c03c1b2b3b01"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_CTL_EN_MASK&#160;&#160;&#160;0x00000001</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Enable / SW Enable Mask. </p>

</div>
</div>
<a class="anchor" id="ga68088d2cf45788126489895482f52276"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_CTL_FSYNC_MASK&#160;&#160;&#160;0x40000000</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Frame Sync Reset Mask. </p>

</div>
</div>
<a class="anchor" id="gaa5d6b91c6ac72faf3a38044153f373d4"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_CTL_OFFSET&#160;&#160;&#160;0x000</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Control Offset. </p>

</div>
</div>
<a class="anchor" id="ga75f6be92e492fb0a76e9f530939467af"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_CTL_RUE_MASK&#160;&#160;&#160;0x00000002</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Register Update Enable Mask. </p>

</div>
</div>
<a class="anchor" id="ga5071d9f484bd2b71197794e55ccdd92e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_CTL_SW_RST_MASK&#160;&#160;&#160;0x80000000</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Core Reset Mask. </p>

</div>
</div>
<a class="anchor" id="ga2a84453f73f690e671aa3b2ede645fb0"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOsd_Disable</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">InstancePtr</td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd_8h.html">xosd.h</a>&gt;</code></p>
<b>Value:</b><div class="fragment"><div class="line"><a class="code" href="group__osd__v4__0.html#ga37791d01d7ba72baa57bd45c2744a6b7">XOsd_WriteReg</a>((InstancePtr)-&gt;Config.BaseAddress, (<a class="code" href="group__osd__v4__0.html#gaa5d6b91c6ac72faf3a38044153f373d4">XOSD_CTL_OFFSET</a>), \</div>
<div class="line">                ((<a class="code" href="group__osd__v4__0.html#ga09c0fe42f0cb0fe4a84e84acb6d548f3">XOsd_ReadReg</a>((InstancePtr)-&gt;Config.BaseAddress, \</div>
<div class="line">                        (<a class="code" href="group__osd__v4__0.html#gaa5d6b91c6ac72faf3a38044153f373d4">XOSD_CTL_OFFSET</a>))) &amp; (~(<a class="code" href="group__osd__v4__0.html#gaf80d798ea9734a4c56e7c03c1b2b3b01">XOSD_CTL_EN_MASK</a>))))</div>
<div class="ttc" id="group__osd__v4__0_html_ga09c0fe42f0cb0fe4a84e84acb6d548f3"><div class="ttname"><a href="group__osd__v4__0.html#ga09c0fe42f0cb0fe4a84e84acb6d548f3">XOsd_ReadReg</a></div><div class="ttdeci">#define XOsd_ReadReg(BaseAddress, RegOffset)</div><div class="ttdoc">This function reads the given register. </div><div class="ttdef"><b>Definition:</b> xosd_hw.h:829</div></div>
<div class="ttc" id="group__osd__v4__0_html_ga37791d01d7ba72baa57bd45c2744a6b7"><div class="ttname"><a href="group__osd__v4__0.html#ga37791d01d7ba72baa57bd45c2744a6b7">XOsd_WriteReg</a></div><div class="ttdeci">#define XOsd_WriteReg(BaseAddress, RegOffset, Data)</div><div class="ttdoc">This function writes the given register. </div><div class="ttdef"><b>Definition:</b> xosd_hw.h:847</div></div>
<div class="ttc" id="group__osd__v4__0_html_gaa5d6b91c6ac72faf3a38044153f373d4"><div class="ttname"><a href="group__osd__v4__0.html#gaa5d6b91c6ac72faf3a38044153f373d4">XOSD_CTL_OFFSET</a></div><div class="ttdeci">#define XOSD_CTL_OFFSET</div><div class="ttdoc">Control Offset. </div><div class="ttdef"><b>Definition:</b> xosd_hw.h:90</div></div>
<div class="ttc" id="group__osd__v4__0_html_gaf80d798ea9734a4c56e7c03c1b2b3b01"><div class="ttname"><a href="group__osd__v4__0.html#gaf80d798ea9734a4c56e7c03c1b2b3b01">XOSD_CTL_EN_MASK</a></div><div class="ttdeci">#define XOSD_CTL_EN_MASK</div><div class="ttdoc">Enable / SW Enable Mask. </div><div class="ttdef"><b>Definition:</b> xosd_hw.h:728</div></div>
</div><!-- fragment -->
<p>This function macro disables an OSD core. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_osd.html" title="The XOsd instance data. ">XOsd</a> instance to be worked on.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>C-style signature: void <a class="el" href="group__osd__v4__0.html#ga2a84453f73f690e671aa3b2ede645fb0" title="This function macro disables an OSD core. ">XOsd_Disable(XOsd *InstancePtr)</a> </dd></dl>

</div>
</div>
<a class="anchor" id="gae6e41c067d999ee6cdc29d3868ec8be8"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOsd_Enable</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">InstancePtr</td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd_8h.html">xosd.h</a>&gt;</code></p>
<b>Value:</b><div class="fragment"><div class="line"><a class="code" href="group__osd__v4__0.html#ga37791d01d7ba72baa57bd45c2744a6b7">XOsd_WriteReg</a>((InstancePtr)-&gt;Config.BaseAddress, (<a class="code" href="group__osd__v4__0.html#gaa5d6b91c6ac72faf3a38044153f373d4">XOSD_CTL_OFFSET</a>), \</div>
<div class="line">                ((<a class="code" href="group__osd__v4__0.html#ga09c0fe42f0cb0fe4a84e84acb6d548f3">XOsd_ReadReg</a>((InstancePtr)-&gt;Config.BaseAddress, \</div>
<div class="line">                        (<a class="code" href="group__osd__v4__0.html#gaa5d6b91c6ac72faf3a38044153f373d4">XOSD_CTL_OFFSET</a>))) | (<a class="code" href="group__osd__v4__0.html#gaf80d798ea9734a4c56e7c03c1b2b3b01">XOSD_CTL_EN_MASK</a>)))</div>
<div class="ttc" id="group__osd__v4__0_html_ga09c0fe42f0cb0fe4a84e84acb6d548f3"><div class="ttname"><a href="group__osd__v4__0.html#ga09c0fe42f0cb0fe4a84e84acb6d548f3">XOsd_ReadReg</a></div><div class="ttdeci">#define XOsd_ReadReg(BaseAddress, RegOffset)</div><div class="ttdoc">This function reads the given register. </div><div class="ttdef"><b>Definition:</b> xosd_hw.h:829</div></div>
<div class="ttc" id="group__osd__v4__0_html_ga37791d01d7ba72baa57bd45c2744a6b7"><div class="ttname"><a href="group__osd__v4__0.html#ga37791d01d7ba72baa57bd45c2744a6b7">XOsd_WriteReg</a></div><div class="ttdeci">#define XOsd_WriteReg(BaseAddress, RegOffset, Data)</div><div class="ttdoc">This function writes the given register. </div><div class="ttdef"><b>Definition:</b> xosd_hw.h:847</div></div>
<div class="ttc" id="group__osd__v4__0_html_gaa5d6b91c6ac72faf3a38044153f373d4"><div class="ttname"><a href="group__osd__v4__0.html#gaa5d6b91c6ac72faf3a38044153f373d4">XOSD_CTL_OFFSET</a></div><div class="ttdeci">#define XOSD_CTL_OFFSET</div><div class="ttdoc">Control Offset. </div><div class="ttdef"><b>Definition:</b> xosd_hw.h:90</div></div>
<div class="ttc" id="group__osd__v4__0_html_gaf80d798ea9734a4c56e7c03c1b2b3b01"><div class="ttname"><a href="group__osd__v4__0.html#gaf80d798ea9734a4c56e7c03c1b2b3b01">XOSD_CTL_EN_MASK</a></div><div class="ttdeci">#define XOSD_CTL_EN_MASK</div><div class="ttdoc">Enable / SW Enable Mask. </div><div class="ttdef"><b>Definition:</b> xosd_hw.h:728</div></div>
</div><!-- fragment -->
<p>This function macro enables an OSD core. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_osd.html" title="The XOsd instance data. ">XOsd</a> instance to be worked on.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>C-style signature: void <a class="el" href="group__osd__v4__0.html#gae6e41c067d999ee6cdc29d3868ec8be8" title="This function macro enables an OSD core. ">XOsd_Enable(XOsd *InstancePtr)</a> </dd></dl>

</div>
</div>
<a class="anchor" id="gaa7d0a9eb85f31e590dadf6b274a9281e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_ERR_ALL_ERR_MASK&#160;&#160;&#160;0xFFFFFFFF</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>OSD Layer 0 to Layer 7 error for EOL late or early early or SOF late or early Mask. </p>

</div>
</div>
<a class="anchor" id="gafb5a121bc4d2c540ac287e76d28078e0"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_ERR_LAYER0_EOL_EARLY_MASK&#160;&#160;&#160;0x00000001</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>OSD Layer 0 error for EOL early Mask. </p>

</div>
</div>
<a class="anchor" id="ga5c5df68bcab4acc7da9bfe69d98f600e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_ERR_LAYER0_EOL_LATE_MASK&#160;&#160;&#160;0x00000002</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>OSD Layer 0 error for EOL late Mask. </p>

</div>
</div>
<a class="anchor" id="ga7517eb9b05d4312d18ffdff9d8ca1d46"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_ERR_LAYER0_SOF_EARLY_MASK&#160;&#160;&#160;0x00000004</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>OSD Layer 0 error for SOF early Mask. </p>

</div>
</div>
<a class="anchor" id="gaa6466702b2f31b4bd369aaa70957dced"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_ERR_LAYER0_SOF_LATE_MASK&#160;&#160;&#160;0x00000008</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>OSD Layer 0 error for SOF late Mask. </p>

</div>
</div>
<a class="anchor" id="ga8a66bd271a23414c3ef69ebaf016ec18"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_ERR_LAYER1_EOL_EARLY_MASK&#160;&#160;&#160;0x00000010</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>OSD Layer 1 error for EOL early Mask. </p>

</div>
</div>
<a class="anchor" id="gabe892325b1d348a98464f217ec422cb7"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_ERR_LAYER1_EOL_LATE_MASK&#160;&#160;&#160;0x00000020</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>OSD Layer 1 error for EOL late Mask. </p>

</div>
</div>
<a class="anchor" id="ga1a749387fc7c57e40de48628d3a9f732"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_ERR_LAYER1_SOF_EARLY_MASK&#160;&#160;&#160;0x00000040</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>OSD Layer 1 error for SOF early Mask. </p>

</div>
</div>
<a class="anchor" id="gade7769e8c273bdb670dbd7c388355f7d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_ERR_LAYER1_SOF_LATE_MASK&#160;&#160;&#160;0x00000080</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>OSD Layer 1 error for SOF late Mask. </p>

</div>
</div>
<a class="anchor" id="gad9f946ee2f6409d2fb370c88f35953c5"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_ERR_LAYER2_EOL_EARLY_MASK&#160;&#160;&#160;0x00000100</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>OSD Layer 2 error for EOL early Mask. </p>

</div>
</div>
<a class="anchor" id="ga969a25b0bb62c10731102993e25ed5e8"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_ERR_LAYER2_EOL_LATE_MASK&#160;&#160;&#160;0x00000200</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>OSD Layer 2 error for EOL late Mask. </p>

</div>
</div>
<a class="anchor" id="ga7abb69836b37481f2de34f71b4ab89ed"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_ERR_LAYER2_SOF_EARLY_MASK&#160;&#160;&#160;0x00000400</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>OSD Layer 2 error for SOF early Mask. </p>

</div>
</div>
<a class="anchor" id="ga6f56d28d089d815b8b1bd48857be1055"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_ERR_LAYER2_SOF_LATE_MASK&#160;&#160;&#160;0x00000800</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>OSD Layer 2 error for SOF late Mask. </p>

</div>
</div>
<a class="anchor" id="ga83c32dd2054d8c53d9e0c185e644f770"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_ERR_LAYER3_EOL_EARLY_MASK&#160;&#160;&#160;0x00001000</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>OSD Layer 3 error for EOL early Mask. </p>

</div>
</div>
<a class="anchor" id="gab91ec7831a5f0737dde3c64c696e219d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_ERR_LAYER3_EOL_LATE_MASK&#160;&#160;&#160;0x00002000</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>OSD Layer 3 error for EOL late Mask. </p>

</div>
</div>
<a class="anchor" id="ga216a452cd347f156c8aad270a070d391"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_ERR_LAYER3_SOF_EARLY_MASK&#160;&#160;&#160;0x00004000</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>OSD Layer 3 error for SOF early Mask. </p>

</div>
</div>
<a class="anchor" id="ga5391bbfec33b3effa54a4bb604fe6278"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_ERR_LAYER3_SOF_LATE_MASK&#160;&#160;&#160;0x00008000</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>OSD Layer 3 error for SOF late Mask. </p>

</div>
</div>
<a class="anchor" id="ga929099f2d2d44a9cbb9a69e58d4bcb3e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_ERR_LAYER4_EOL_EARLY_MASK&#160;&#160;&#160;0x00010000</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>OSD Layer 4 error for EOL early Mask. </p>

</div>
</div>
<a class="anchor" id="gac53283fca0ed05577a667cc4ab9bc2cd"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_ERR_LAYER4_EOL_LATE_MASK&#160;&#160;&#160;0x00020000</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>OSD Layer 4 error for EOL late Mask. </p>

</div>
</div>
<a class="anchor" id="gaec2e32d4ddf184fb3555b79153aec8d3"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_ERR_LAYER4_SOF_EARLY_MASK&#160;&#160;&#160;0x00040000</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>OSD Layer 4 error for SOF early Mask. </p>

</div>
</div>
<a class="anchor" id="gab329ef2807aaf752b2c01a6bc9d9d0ba"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_ERR_LAYER4_SOF_LATE_MASK&#160;&#160;&#160;0x00080000</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>OSD Layer 4 error for SOF late Mask. </p>

</div>
</div>
<a class="anchor" id="ga08e42d245ee21438fdab438a86006f08"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_ERR_LAYER5_EOL_EARLY_MASK&#160;&#160;&#160;0x00100000</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>OSD Layer 5 error for EOL early Mask. </p>

</div>
</div>
<a class="anchor" id="ga59b8807097445c26d93164a11e980284"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_ERR_LAYER5_EOL_LATE_MASK&#160;&#160;&#160;0x00200000</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>OSD Layer 5 error for EOL late Mask. </p>

</div>
</div>
<a class="anchor" id="ga98ffc4be6fa41cd4e4b610d96d820207"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_ERR_LAYER5_SOF_EARLY_MASK&#160;&#160;&#160;0x00400000</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>OSD Layer 5 error for SOF early Mask. </p>

</div>
</div>
<a class="anchor" id="ga8420356e1af56b65bbb0dc1e5730309e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_ERR_LAYER5_SOF_LATE_MASK&#160;&#160;&#160;0x00800000</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>OSD Layer 5 error for SOF late Mask. </p>

</div>
</div>
<a class="anchor" id="ga6091712dca160402ed2915518be2f07b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_ERR_LAYER6_EOL_EARLY_MASK&#160;&#160;&#160;0x01000000</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>OSD Layer 6 error for EOL early Mask. </p>

</div>
</div>
<a class="anchor" id="gaedbe10c1d98c47e2dd878c45191e103b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_ERR_LAYER6_EOL_LATE_MASK&#160;&#160;&#160;0x02000000</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>OSD Layer 6 error for EOL late Mask. </p>

</div>
</div>
<a class="anchor" id="gada693dd13ea9d921bdf5b4950c72661e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_ERR_LAYER6_SOF_EARLY_MASK&#160;&#160;&#160;0x04000000</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>OSD Layer 6 error for SOF early Mask. </p>

</div>
</div>
<a class="anchor" id="ga7df8e951554bf328c19cae2d3813c5a0"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_ERR_LAYER6_SOF_LATE_MASK&#160;&#160;&#160;0x08000000</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>OSD Layer 6 error for SOF late Mask. </p>

</div>
</div>
<a class="anchor" id="ga41581b6e7d8cdee3bdb5f5c8d6e6eba2"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_ERR_LAYER7_EOL_EARLY_MASK&#160;&#160;&#160;0x10000000</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>OSD Layer 7 error for EOL early. </p>

</div>
</div>
<a class="anchor" id="gaba797c4407966a78426755393075bcc8"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_ERR_LAYER7_EOL_LATE_MASK&#160;&#160;&#160;0x20000000</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>OSD Layer 7 error for EOL late Mask. </p>

</div>
</div>
<a class="anchor" id="ga50d162b4eea9e79a3414dbe166db87d7"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_ERR_LAYER7_SOF_EARLY_MASK&#160;&#160;&#160;0x40000000</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>OSD Layer 7 error for SOF early Mask. </p>

</div>
</div>
<a class="anchor" id="gac6704ba3bfc1be81b2667be690a63fb2"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_ERR_LAYER7_SOF_LATE_MASK&#160;&#160;&#160;0x80000000</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>OSD Layer 7 error for SOF late Mask. </p>

</div>
</div>
<a class="anchor" id="ga1410ce6e4fff4ea10154e9724d0823af"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_ERROR_OFFSET&#160;&#160;&#160;0x008</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Error Offset. </p>

</div>
</div>
<a class="anchor" id="gaabff64a3ad88851d9c886d6bf91f6942"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_FONT_BIT_TO_BYTE&#160;&#160;&#160;8</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Ratio to convert font size to byte. </p>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#ga6579cb01322e477e72faec9ea6feee63">XOsd_LoadCharacterSetBank()</a>.</p>

</div>
</div>
<a class="anchor" id="gabaa8b4a92fcfc0ae2152c87249975db9"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOsd_FSyncReset&#160;&#160;&#160;<a class="el" href="group__osd__v4__0.html#ga3a758a90dded736022ab70e7c0be8796">XOsd_SyncReset</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd_8h.html">xosd.h</a>&gt;</code></p>

<p>This macro resets the OSD core at the end of the frame being processed. </p>
<p>It enables core automatically synchronizes to the SOF of the core to prevent image tearing. This function macro is differ from <a class="el" href="group__osd__v4__0.html#ga2ccc3d88129121707113a37dd1a7dea8" title="This function macro resets an OSD core This effects the core immediately, and may cause image tearing...">XOsd_Reset()</a>.</p>
<p>On the next rising-edge of SOF following a call to <a class="el" href="group__osd__v4__0.html#ga3a758a90dded736022ab70e7c0be8796" title="This function macro resets a OSD core at the end of the frame being processed. ">XOsd_SyncReset()</a>, all of the core's configuration registers and outputs will be reset, then the reset flag will be immediately released, allowing the core to immediately resume default operation. </p>

</div>
</div>
<a class="anchor" id="ga45ae5aa9dfc53098d0b710623fad8872"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_GC_BANK_NUM&#160;&#160;&#160;2</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>The number of Banks in each Graphics controller. </p>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#ga6579cb01322e477e72faec9ea6feee63">XOsd_LoadCharacterSetBank()</a>, <a class="el" href="group__osd__v4__0.html#ga9d28c4453d039dc09b540d55c78c80b2">XOsd_LoadColorLUTBank()</a>, <a class="el" href="group__osd__v4__0.html#ga55937cb3259f5843c9e1beec4e126955">XOsd_LoadInstructionList()</a>, <a class="el" href="group__osd__v4__0.html#ga5a76210dc91d4a51111855bbc501c4e8">XOsd_LoadTextBank()</a>, and <a class="el" href="group__osd__v4__0.html#ga5552532bfdfcd272722180e71d6c7b75">XOsd_SetActiveBank()</a>.</p>

</div>
</div>
<a class="anchor" id="ga11a12b88b43abe8e5fca75b3b4b88ae3"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_GCABA_CHR_MASK&#160;&#160;&#160;0xFF000000</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Set the active Character Bank Mask. </p>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#ga5552532bfdfcd272722180e71d6c7b75">XOsd_SetActiveBank()</a>.</p>

</div>
</div>
<a class="anchor" id="ga3ef9c844a0695a6af31f5aba5254ebdb"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_GCABA_CHR_SHIFT&#160;&#160;&#160;24</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Bit shift of active Character Bank. </p>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#ga6579cb01322e477e72faec9ea6feee63">XOsd_LoadCharacterSetBank()</a>, and <a class="el" href="group__osd__v4__0.html#ga5552532bfdfcd272722180e71d6c7b75">XOsd_SetActiveBank()</a>.</p>

</div>
</div>
<a class="anchor" id="ga2394cb98a760d2ffc447f4c6ddd67720"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_GCABA_COL_MASK&#160;&#160;&#160;0x0000FF00</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Set the active Color Table Bank Mask. </p>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#ga5552532bfdfcd272722180e71d6c7b75">XOsd_SetActiveBank()</a>.</p>

</div>
</div>
<a class="anchor" id="ga0180a6f642268480d81a2a006ce8b85a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_GCABA_COL_SHIFT&#160;&#160;&#160;8</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Bit shift of active Color Table Bank. </p>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#ga9d28c4453d039dc09b540d55c78c80b2">XOsd_LoadColorLUTBank()</a>, and <a class="el" href="group__osd__v4__0.html#ga5552532bfdfcd272722180e71d6c7b75">XOsd_SetActiveBank()</a>.</p>

</div>
</div>
<a class="anchor" id="ga0b67b99445f37ebb190b4bd69edc3f58"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_GCABA_INS_MASK&#160;&#160;&#160;0x000000FF</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Set the active instruction Bank Mask. </p>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#ga5552532bfdfcd272722180e71d6c7b75">XOsd_SetActiveBank()</a>.</p>

</div>
</div>
<a class="anchor" id="gaf8a5cab153ddb20712278001ab8bf534"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_GCABA_OFFSET&#160;&#160;&#160;0x194</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>GPU Active Bank Address Offset. </p>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#ga6579cb01322e477e72faec9ea6feee63">XOsd_LoadCharacterSetBank()</a>, <a class="el" href="group__osd__v4__0.html#ga9d28c4453d039dc09b540d55c78c80b2">XOsd_LoadColorLUTBank()</a>, <a class="el" href="group__osd__v4__0.html#ga55937cb3259f5843c9e1beec4e126955">XOsd_LoadInstructionList()</a>, <a class="el" href="group__osd__v4__0.html#ga5a76210dc91d4a51111855bbc501c4e8">XOsd_LoadTextBank()</a>, and <a class="el" href="group__osd__v4__0.html#ga5552532bfdfcd272722180e71d6c7b75">XOsd_SetActiveBank()</a>.</p>

</div>
</div>
<a class="anchor" id="gaefe55dfbb30ee83089584e80d86471c7"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_GCABA_TXT_MASK&#160;&#160;&#160;0x00FF0000</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Set the active Text Bank Mask. </p>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#ga5552532bfdfcd272722180e71d6c7b75">XOsd_SetActiveBank()</a>.</p>

</div>
</div>
<a class="anchor" id="gaf4d8ce31dbe126d0fa8f5976c80de11d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_GCABA_TXT_SHIFT&#160;&#160;&#160;16</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Bit shift of active Text Bank. </p>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#ga5a76210dc91d4a51111855bbc501c4e8">XOsd_LoadTextBank()</a>, and <a class="el" href="group__osd__v4__0.html#ga5552532bfdfcd272722180e71d6c7b75">XOsd_SetActiveBank()</a>.</p>

</div>
</div>
<a class="anchor" id="ga09280c9581cb52b21792d38917a29ba2"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_GCD_OFFSET&#160;&#160;&#160;0x198</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>GPU Data Offset. </p>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#ga6579cb01322e477e72faec9ea6feee63">XOsd_LoadCharacterSetBank()</a>, <a class="el" href="group__osd__v4__0.html#ga9d28c4453d039dc09b540d55c78c80b2">XOsd_LoadColorLUTBank()</a>, <a class="el" href="group__osd__v4__0.html#ga55937cb3259f5843c9e1beec4e126955">XOsd_LoadInstructionList()</a>, and <a class="el" href="group__osd__v4__0.html#ga5a76210dc91d4a51111855bbc501c4e8">XOsd_LoadTextBank()</a>.</p>

</div>
</div>
<a class="anchor" id="ga744f4c46706bb0fb5b0d3de3c5826c7f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_GCWBA_BANK_MASK&#160;&#160;&#160;0x00000007</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Controls which bank to write GPU instructions and Color LUT data into. </p>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#ga6579cb01322e477e72faec9ea6feee63">XOsd_LoadCharacterSetBank()</a>, <a class="el" href="group__osd__v4__0.html#ga9d28c4453d039dc09b540d55c78c80b2">XOsd_LoadColorLUTBank()</a>, <a class="el" href="group__osd__v4__0.html#ga55937cb3259f5843c9e1beec4e126955">XOsd_LoadInstructionList()</a>, and <a class="el" href="group__osd__v4__0.html#ga5a76210dc91d4a51111855bbc501c4e8">XOsd_LoadTextBank()</a>.</p>

</div>
</div>
<a class="anchor" id="ga4aeaabbe94c0e21210ed6ab657844ef3"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_GCWBA_CHR0&#160;&#160;&#160;0x00000006</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Character Set RAM 0. </p>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#ga6579cb01322e477e72faec9ea6feee63">XOsd_LoadCharacterSetBank()</a>.</p>

</div>
</div>
<a class="anchor" id="gaff47cfc532bc48818fc99502c9bcb7b3"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_GCWBA_CHR1&#160;&#160;&#160;0x00000007</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Character Set RAM 1. </p>

</div>
</div>
<a class="anchor" id="gaaffb3c9e8b2db21168a8fb96a4566fea"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_GCWBA_COL0&#160;&#160;&#160;0x00000002</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Color LUT RAM 0. </p>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#ga9d28c4453d039dc09b540d55c78c80b2">XOsd_LoadColorLUTBank()</a>.</p>

</div>
</div>
<a class="anchor" id="ga277ca4377da8071f9620ecd75c364fef"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_GCWBA_COL1&#160;&#160;&#160;0x00000003</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Color LUT RAM 1. </p>

</div>
</div>
<a class="anchor" id="ga9b1814d86e5233adee245c745fa4930e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_GCWBA_GCNUM_MASK&#160;&#160;&#160;0x00000700</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Graphics Controller Number Mask. </p>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#ga6579cb01322e477e72faec9ea6feee63">XOsd_LoadCharacterSetBank()</a>, <a class="el" href="group__osd__v4__0.html#ga9d28c4453d039dc09b540d55c78c80b2">XOsd_LoadColorLUTBank()</a>, <a class="el" href="group__osd__v4__0.html#ga55937cb3259f5843c9e1beec4e126955">XOsd_LoadInstructionList()</a>, and <a class="el" href="group__osd__v4__0.html#ga5a76210dc91d4a51111855bbc501c4e8">XOsd_LoadTextBank()</a>.</p>

</div>
</div>
<a class="anchor" id="gaa649271aac06a31917c73c8a98728bee"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_GCWBA_GCNUM_SHIFT&#160;&#160;&#160;8</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Bit shift of Graphics Controller Number. </p>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#ga6579cb01322e477e72faec9ea6feee63">XOsd_LoadCharacterSetBank()</a>, <a class="el" href="group__osd__v4__0.html#ga9d28c4453d039dc09b540d55c78c80b2">XOsd_LoadColorLUTBank()</a>, <a class="el" href="group__osd__v4__0.html#ga55937cb3259f5843c9e1beec4e126955">XOsd_LoadInstructionList()</a>, and <a class="el" href="group__osd__v4__0.html#ga5a76210dc91d4a51111855bbc501c4e8">XOsd_LoadTextBank()</a>.</p>

</div>
</div>
<a class="anchor" id="ga964674dbcc6e06590d99a20430cab2d6"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_GCWBA_INS0&#160;&#160;&#160;0x00000000</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Instruction RAM 0. </p>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#ga55937cb3259f5843c9e1beec4e126955">XOsd_LoadInstructionList()</a>.</p>

</div>
</div>
<a class="anchor" id="ga18160d3eb42273df9b5537e1472231b8"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_GCWBA_INS1&#160;&#160;&#160;0x00000001</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Instruction RAM 1. </p>

</div>
</div>
<a class="anchor" id="gaad8f1c87d9bbbfda000f872824e8300a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_GCWBA_OFFSET&#160;&#160;&#160;0x190</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>GPU Write Bank Address Offset. </p>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#ga6579cb01322e477e72faec9ea6feee63">XOsd_LoadCharacterSetBank()</a>, <a class="el" href="group__osd__v4__0.html#ga9d28c4453d039dc09b540d55c78c80b2">XOsd_LoadColorLUTBank()</a>, <a class="el" href="group__osd__v4__0.html#ga55937cb3259f5843c9e1beec4e126955">XOsd_LoadInstructionList()</a>, and <a class="el" href="group__osd__v4__0.html#ga5a76210dc91d4a51111855bbc501c4e8">XOsd_LoadTextBank()</a>.</p>

</div>
</div>
<a class="anchor" id="gaced5e2ebb0ea5479c310434321bc57ed"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_GCWBA_TXT0&#160;&#160;&#160;0x00000004</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Text RAM 0. </p>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#ga5a76210dc91d4a51111855bbc501c4e8">XOsd_LoadTextBank()</a>.</p>

</div>
</div>
<a class="anchor" id="gae66d1df1cea042e3d9ee49d55eea04b4"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_GCWBA_TXT1&#160;&#160;&#160;0x00000005</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Text RAM 1. </p>

</div>
</div>
<a class="anchor" id="ga310a282ec96e49d83d367881531a88ca"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_H_</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd_8h.html">xosd.h</a>&gt;</code></p>

<p>Prevent circular inclusions by using protection macros. </p>

</div>
</div>
<a class="anchor" id="ga51a9fc13b8a6a270b1a1c531f54dcd8a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_HW_H_</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Prevent circular inclusions by using protection macros. </p>

</div>
</div>
<a class="anchor" id="gaf99a287707b01d05bb7ad6aadbe7d328"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_IER_OFFSET&#160;&#160;&#160;0x00C</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Interrupt Enable Register Offset. </p>

</div>
</div>
<a class="anchor" id="ga2e8bfbd972e0ac9e0ba6f163f424a83e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_INS0&#160;&#160;&#160;0</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Instruction word 0 offset. </p>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#ga7abff2415587a54c259f159fc780e2cc">XOsd_CreateInstruction()</a>.</p>

</div>
</div>
<a class="anchor" id="ga0f5a79d13524e9f9cc1dd1bb1c6b4e17"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_INS0_GCNUM_MASK&#160;&#160;&#160;0x07000000</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Graphics controller number (GC#) Mask. </p>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#ga7abff2415587a54c259f159fc780e2cc">XOsd_CreateInstruction()</a>.</p>

</div>
</div>
<a class="anchor" id="gac3a8f3b2a9b5033e28b4d01816831069"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_INS0_GCNUM_SHIFT&#160;&#160;&#160;24</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Bit shift number of GC#. </p>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#ga7abff2415587a54c259f159fc780e2cc">XOsd_CreateInstruction()</a>.</p>

</div>
</div>
<a class="anchor" id="gaee38041f6b3686d192becfdc9d625108"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_INS0_OPCODE_MASK&#160;&#160;&#160;0xF0000000</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Operation Code (OpCode) Mask. </p>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#ga7abff2415587a54c259f159fc780e2cc">XOsd_CreateInstruction()</a>.</p>

</div>
</div>
<a class="anchor" id="gaf95cc7852856ccf13f0d2b96fc17507d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_INS0_OPCODE_SHIFT&#160;&#160;&#160;28</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Bit shift number of OpCode. </p>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#ga7abff2415587a54c259f159fc780e2cc">XOsd_CreateInstruction()</a>.</p>

</div>
</div>
<a class="anchor" id="ga316274c11c4bdf01881be2e5fa8c3ddd"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_INS0_XEND_MASK&#160;&#160;&#160;0x00FFF000</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Horizontal end pixel of the object Mask. </p>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#ga7abff2415587a54c259f159fc780e2cc">XOsd_CreateInstruction()</a>.</p>

</div>
</div>
<a class="anchor" id="ga0718123f4128faf36a3613d4d83d9bc9"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_INS0_XEND_SHIFT&#160;&#160;&#160;12</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Bit shift number of Horizontal end pixel of the object. </p>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#ga7abff2415587a54c259f159fc780e2cc">XOsd_CreateInstruction()</a>.</p>

</div>
</div>
<a class="anchor" id="gac28f5bcf9429cd6d5db7ba73dd8037e0"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_INS0_XSTART_MASK&#160;&#160;&#160;0x00000FFF</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Horizontal start pixel of the Object Mask. </p>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#ga7abff2415587a54c259f159fc780e2cc">XOsd_CreateInstruction()</a>.</p>

</div>
</div>
<a class="anchor" id="ga85673ee70fcf9f62d30dbbe12f9ea4a6"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_INS1&#160;&#160;&#160;1</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Instruction word 1 offset. </p>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#ga7abff2415587a54c259f159fc780e2cc">XOsd_CreateInstruction()</a>.</p>

</div>
</div>
<a class="anchor" id="ga845d109b3f71bafffbad75d0fc096e95"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_INS1_TXTINDEX_MASK&#160;&#160;&#160;0x0000000F</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>String Index. </p>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#ga7abff2415587a54c259f159fc780e2cc">XOsd_CreateInstruction()</a>.</p>

</div>
</div>
<a class="anchor" id="gab3b51f42fb458498b44640a4d7f48447"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_INS2&#160;&#160;&#160;2</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Instruction word 2 offset. </p>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#ga7abff2415587a54c259f159fc780e2cc">XOsd_CreateInstruction()</a>.</p>

</div>
</div>
<a class="anchor" id="ga308b392a1c8f2e3b58c34b60f3c832e2"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_INS2_OBJSIZE_MASK&#160;&#160;&#160;0xFF000000</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Object Size Mask. </p>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#ga7abff2415587a54c259f159fc780e2cc">XOsd_CreateInstruction()</a>.</p>

</div>
</div>
<a class="anchor" id="ga2e64473070f0ad81308d0fdde70c846e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_INS2_OBJSIZE_SHIFT&#160;&#160;&#160;24</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Bit shift number of Object Size. </p>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#ga7abff2415587a54c259f159fc780e2cc">XOsd_CreateInstruction()</a>.</p>

</div>
</div>
<a class="anchor" id="gaf441c303e232e267cecd015457c3b059"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_INS2_YEND_MASK&#160;&#160;&#160;0x00FFF000</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Vertical end line of the object Mask. </p>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#ga7abff2415587a54c259f159fc780e2cc">XOsd_CreateInstruction()</a>.</p>

</div>
</div>
<a class="anchor" id="ga557eb7583fc6e177b653144e1dd46309"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_INS2_YEND_SHIFT&#160;&#160;&#160;12</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Bit shift number of Vertical end line of the object. </p>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#ga7abff2415587a54c259f159fc780e2cc">XOsd_CreateInstruction()</a>.</p>

</div>
</div>
<a class="anchor" id="ga572eaf61ee8df22c543f6cf017fd4b4d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_INS2_YSTART_MASK&#160;&#160;&#160;0x00000FFF</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Vertical start line of the Object Mask. </p>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#ga7abff2415587a54c259f159fc780e2cc">XOsd_CreateInstruction()</a>.</p>

</div>
</div>
<a class="anchor" id="gaffb751247452fc737ba7f4c5a2a0a158"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_INS3&#160;&#160;&#160;3</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Instruction word 3 offset. </p>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#ga7abff2415587a54c259f159fc780e2cc">XOsd_CreateInstruction()</a>.</p>

</div>
</div>
<a class="anchor" id="gabaf54e22c321fa30301173f7a7a8404c"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_INS3_COL_MASK&#160;&#160;&#160;0x0000000F</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Color Index for Box/Text Mask. </p>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#ga7abff2415587a54c259f159fc780e2cc">XOsd_CreateInstruction()</a>.</p>

</div>
</div>
<a class="anchor" id="ga1de0b5cabf37d0d1036692d209a2ffeb"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_INS_MEM_SIZE_TO_NUM&#160;&#160;&#160;1</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Conversion to the number of instructions from the instruction memory size. </p>

</div>
</div>
<a class="anchor" id="ga8c2bdbf05a06c913c482769abb207a04"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_INS_OPCODE_BOX&#160;&#160;&#160;0xA</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Box. </p>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#ga7abff2415587a54c259f159fc780e2cc">XOsd_CreateInstruction()</a>.</p>

</div>
</div>
<a class="anchor" id="ga06d2e8c7a16846a74ffa8413261c1b42"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_INS_OPCODE_BOXTXT&#160;&#160;&#160;0xF</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Box Text. </p>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#ga7abff2415587a54c259f159fc780e2cc">XOsd_CreateInstruction()</a>.</p>

</div>
</div>
<a class="anchor" id="ga020a93ee98e26b3e9bef6d37bdca6d93"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_INS_OPCODE_END&#160;&#160;&#160;0x0</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>End of instruction list. </p>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#ga7abff2415587a54c259f159fc780e2cc">XOsd_CreateInstruction()</a>.</p>

</div>
</div>
<a class="anchor" id="ga4d4d7f9062d81c4db38142348c23db3c"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_INS_OPCODE_LINE&#160;&#160;&#160;0xC</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Line. </p>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#ga7abff2415587a54c259f159fc780e2cc">XOsd_CreateInstruction()</a>.</p>

</div>
</div>
<a class="anchor" id="gab378c3a2033c60420990fc0c6e035de8"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_INS_OPCODE_NOP&#160;&#160;&#160;0x8</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>NOP. </p>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#ga7abff2415587a54c259f159fc780e2cc">XOsd_CreateInstruction()</a>.</p>

</div>
</div>
<a class="anchor" id="ga594d67ea3248e5eb9cc243f7436c0506"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_INS_OPCODE_TXT&#160;&#160;&#160;0xE</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Text. </p>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#ga7abff2415587a54c259f159fc780e2cc">XOsd_CreateInstruction()</a>.</p>

</div>
</div>
<a class="anchor" id="gaf52a55e9ca22269266faf951be024ee1"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_INS_SIZE&#160;&#160;&#160;4</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Size of an instruction in words. </p>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#ga7abff2415587a54c259f159fc780e2cc">XOsd_CreateInstruction()</a>, and <a class="el" href="group__osd__v4__0.html#ga55937cb3259f5843c9e1beec4e126955">XOsd_LoadInstructionList()</a>.</p>

</div>
</div>
<a class="anchor" id="ga2507152f445947e19e16ac59939adc9e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOsd_IntrClear</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">InstancePtr, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">IntrType&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd_8h.html">xosd.h</a>&gt;</code></p>
<b>Value:</b><div class="fragment"><div class="line"><a class="code" href="group__osd__v4__0.html#ga37791d01d7ba72baa57bd45c2744a6b7">XOsd_WriteReg</a>((InstancePtr)-&gt;Config.BaseAddress, \</div>
<div class="line">                (<a class="code" href="group__osd__v4__0.html#gaee8b66db164a6929f9d75c1e75b6c4f7">XOSD_STATUS_OFFSET</a>), ((IntrType) &amp; (<a class="code" href="group__osd__v4__0.html#gaf0bcfced7a4f1a3f6069c73002ccb9aa">XOSD_IXR_ALLINTR_MASK</a>)))</div>
<div class="ttc" id="group__osd__v4__0_html_gaee8b66db164a6929f9d75c1e75b6c4f7"><div class="ttname"><a href="group__osd__v4__0.html#gaee8b66db164a6929f9d75c1e75b6c4f7">XOSD_STATUS_OFFSET</a></div><div class="ttdeci">#define XOSD_STATUS_OFFSET</div><div class="ttdoc">Status Offset. </div><div class="ttdef"><b>Definition:</b> xosd_hw.h:154</div></div>
<div class="ttc" id="group__osd__v4__0_html_ga37791d01d7ba72baa57bd45c2744a6b7"><div class="ttname"><a href="group__osd__v4__0.html#ga37791d01d7ba72baa57bd45c2744a6b7">XOsd_WriteReg</a></div><div class="ttdeci">#define XOsd_WriteReg(BaseAddress, RegOffset, Data)</div><div class="ttdoc">This function writes the given register. </div><div class="ttdef"><b>Definition:</b> xosd_hw.h:847</div></div>
<div class="ttc" id="group__osd__v4__0_html_gaf0bcfced7a4f1a3f6069c73002ccb9aa"><div class="ttname"><a href="group__osd__v4__0.html#gaf0bcfced7a4f1a3f6069c73002ccb9aa">XOSD_IXR_ALLINTR_MASK</a></div><div class="ttdeci">#define XOSD_IXR_ALLINTR_MASK</div><div class="ttdoc">OR&#39;ing of all Masks. </div><div class="ttdef"><b>Definition:</b> xosd_hw.h:390</div></div>
</div><!-- fragment -->
<p>This function macro clears/acknowledges pending interrupts of the OSD core. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_osd.html" title="The XOsd instance data. ">XOsd</a> instance to be worked on. </td></tr>
    <tr><td class="paramname">IntrType</td><td>is the pending interrupts to clear/acknowledge. Use OR'ing of XOSD_IXR_*_MASK constants defined in <a class="el" href="xosd__hw_8h.html">xosd_hw.h</a> to create this parameter value.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None</dd></dl>
<dl class="section note"><dt>Note</dt><dd>C-style signature: void <a class="el" href="group__osd__v4__0.html#ga2507152f445947e19e16ac59939adc9e" title="This function macro clears/acknowledges pending interrupts of the OSD core. ">XOsd_IntrClear(XOsd *InstancePtr, u32 IntrType)</a> </dd></dl>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#ga7079d6f5586ca603657dac6b9e188105">XOsd_IntrHandler()</a>.</p>

</div>
</div>
<a class="anchor" id="ga53d9596240b76f8887fd519518f21e82"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOsd_IntrDisable</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">InstancePtr, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">IntrType&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd_8h.html">xosd.h</a>&gt;</code></p>
<b>Value:</b><div class="fragment"><div class="line"><a class="code" href="group__osd__v4__0.html#ga37791d01d7ba72baa57bd45c2744a6b7">XOsd_WriteReg</a>((InstancePtr)-&gt;Config.BaseAddress, (<a class="code" href="group__osd__v4__0.html#gaf99a287707b01d05bb7ad6aadbe7d328">XOSD_IER_OFFSET</a>), \</div>
<div class="line">                (((~(IntrType)) &amp; (<a class="code" href="group__osd__v4__0.html#gaf0bcfced7a4f1a3f6069c73002ccb9aa">XOSD_IXR_ALLINTR_MASK</a>)) &amp; \</div>
<div class="line">                        (<a class="code" href="group__osd__v4__0.html#ga09c0fe42f0cb0fe4a84e84acb6d548f3">XOsd_ReadReg</a>((InstancePtr)-&gt;Config.BaseAddress, \</div>
<div class="line">                                (<a class="code" href="group__osd__v4__0.html#gaf99a287707b01d05bb7ad6aadbe7d328">XOSD_IER_OFFSET</a>)))))</div>
<div class="ttc" id="group__osd__v4__0_html_gaf99a287707b01d05bb7ad6aadbe7d328"><div class="ttname"><a href="group__osd__v4__0.html#gaf99a287707b01d05bb7ad6aadbe7d328">XOSD_IER_OFFSET</a></div><div class="ttdeci">#define XOSD_IER_OFFSET</div><div class="ttdoc">Interrupt Enable Register Offset. </div><div class="ttdef"><b>Definition:</b> xosd_hw.h:150</div></div>
<div class="ttc" id="group__osd__v4__0_html_ga09c0fe42f0cb0fe4a84e84acb6d548f3"><div class="ttname"><a href="group__osd__v4__0.html#ga09c0fe42f0cb0fe4a84e84acb6d548f3">XOsd_ReadReg</a></div><div class="ttdeci">#define XOsd_ReadReg(BaseAddress, RegOffset)</div><div class="ttdoc">This function reads the given register. </div><div class="ttdef"><b>Definition:</b> xosd_hw.h:829</div></div>
<div class="ttc" id="group__osd__v4__0_html_ga37791d01d7ba72baa57bd45c2744a6b7"><div class="ttname"><a href="group__osd__v4__0.html#ga37791d01d7ba72baa57bd45c2744a6b7">XOsd_WriteReg</a></div><div class="ttdeci">#define XOsd_WriteReg(BaseAddress, RegOffset, Data)</div><div class="ttdoc">This function writes the given register. </div><div class="ttdef"><b>Definition:</b> xosd_hw.h:847</div></div>
<div class="ttc" id="group__osd__v4__0_html_gaf0bcfced7a4f1a3f6069c73002ccb9aa"><div class="ttname"><a href="group__osd__v4__0.html#gaf0bcfced7a4f1a3f6069c73002ccb9aa">XOSD_IXR_ALLINTR_MASK</a></div><div class="ttdeci">#define XOSD_IXR_ALLINTR_MASK</div><div class="ttdoc">OR&#39;ing of all Masks. </div><div class="ttdef"><b>Definition:</b> xosd_hw.h:390</div></div>
</div><!-- fragment -->
<p>This function macro disables the given individual interrupt(s) on the OSD core. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_osd.html" title="The XOsd instance data. ">XOsd</a> instance to be worked on. </td></tr>
    <tr><td class="paramname">IntrType</td><td>is the bit-mask of the interrupts to be enabled. Bit positions of 1 will be disabled. Bit positions of 0 will keep the previous setting.This mask is formed by OR'ing of XOSD_IXR_*_MASK bits defined in <a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>Any other interrupt not covered by parameter IntrType, if enabled before this macro is called, will remain enabled. C-style signature: void <a class="el" href="group__osd__v4__0.html#ga53d9596240b76f8887fd519518f21e82" title="This function macro disables the given individual interrupt(s) on the OSD core. ">XOsd_IntrDisable(XOsd *InstancePtr, u32 IntrType)</a> </dd></dl>

</div>
</div>
<a class="anchor" id="gac752c2e2d84d0735f45986c2a27df3b2"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOsd_IntrEnable</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">InstancePtr, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">IntrType&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd_8h.html">xosd.h</a>&gt;</code></p>
<b>Value:</b><div class="fragment"><div class="line"><a class="code" href="group__osd__v4__0.html#ga37791d01d7ba72baa57bd45c2744a6b7">XOsd_WriteReg</a>((InstancePtr)-&gt;Config.BaseAddress, (<a class="code" href="group__osd__v4__0.html#gaf99a287707b01d05bb7ad6aadbe7d328">XOSD_IER_OFFSET</a>), \</div>
<div class="line">                (((IntrType) &amp; (<a class="code" href="group__osd__v4__0.html#gaf0bcfced7a4f1a3f6069c73002ccb9aa">XOSD_IXR_ALLINTR_MASK</a>)) | \</div>
<div class="line">                        (<a class="code" href="group__osd__v4__0.html#ga09c0fe42f0cb0fe4a84e84acb6d548f3">XOsd_ReadReg</a>((InstancePtr)-&gt;Config.BaseAddress, \</div>
<div class="line">                                (<a class="code" href="group__osd__v4__0.html#gaf99a287707b01d05bb7ad6aadbe7d328">XOSD_IER_OFFSET</a>)))))</div>
<div class="ttc" id="group__osd__v4__0_html_gaf99a287707b01d05bb7ad6aadbe7d328"><div class="ttname"><a href="group__osd__v4__0.html#gaf99a287707b01d05bb7ad6aadbe7d328">XOSD_IER_OFFSET</a></div><div class="ttdeci">#define XOSD_IER_OFFSET</div><div class="ttdoc">Interrupt Enable Register Offset. </div><div class="ttdef"><b>Definition:</b> xosd_hw.h:150</div></div>
<div class="ttc" id="group__osd__v4__0_html_ga09c0fe42f0cb0fe4a84e84acb6d548f3"><div class="ttname"><a href="group__osd__v4__0.html#ga09c0fe42f0cb0fe4a84e84acb6d548f3">XOsd_ReadReg</a></div><div class="ttdeci">#define XOsd_ReadReg(BaseAddress, RegOffset)</div><div class="ttdoc">This function reads the given register. </div><div class="ttdef"><b>Definition:</b> xosd_hw.h:829</div></div>
<div class="ttc" id="group__osd__v4__0_html_ga37791d01d7ba72baa57bd45c2744a6b7"><div class="ttname"><a href="group__osd__v4__0.html#ga37791d01d7ba72baa57bd45c2744a6b7">XOsd_WriteReg</a></div><div class="ttdeci">#define XOsd_WriteReg(BaseAddress, RegOffset, Data)</div><div class="ttdoc">This function writes the given register. </div><div class="ttdef"><b>Definition:</b> xosd_hw.h:847</div></div>
<div class="ttc" id="group__osd__v4__0_html_gaf0bcfced7a4f1a3f6069c73002ccb9aa"><div class="ttname"><a href="group__osd__v4__0.html#gaf0bcfced7a4f1a3f6069c73002ccb9aa">XOSD_IXR_ALLINTR_MASK</a></div><div class="ttdeci">#define XOSD_IXR_ALLINTR_MASK</div><div class="ttdoc">OR&#39;ing of all Masks. </div><div class="ttdef"><b>Definition:</b> xosd_hw.h:390</div></div>
</div><!-- fragment -->
<p>This function macro enables the given individual interrupt(s) on the OSD core. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_osd.html" title="The XOsd instance data. ">XOsd</a> instance to be worked on. </td></tr>
    <tr><td class="paramname">IntrType</td><td>is the bit-mask of the interrupts to be enabled. Bit positions of 1 will be enabled. Bit positions of 0 will keep the previous setting.This mask is formed by OR'ing of XOSD_IXR_*_MASK bits defined in <a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>The existing enabled interrupt(s) will remain enabled. C-style signature: void <a class="el" href="group__osd__v4__0.html#gac752c2e2d84d0735f45986c2a27df3b2" title="This function macro enables the given individual interrupt(s) on the OSD core. ">XOsd_IntrEnable(XOsd *InstancePtr, u32 IntrType)</a> </dd></dl>

</div>
</div>
<a class="anchor" id="ga89fd83e071e7da016c89f9e155f1453a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOsd_IntrGetPending</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">InstancePtr</td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd_8h.html">xosd.h</a>&gt;</code></p>
<b>Value:</b><div class="fragment"><div class="line"><a class="code" href="group__osd__v4__0.html#ga09c0fe42f0cb0fe4a84e84acb6d548f3">XOsd_ReadReg</a>((InstancePtr)-&gt;Config.BaseAddress, (<a class="code" href="group__osd__v4__0.html#gaf99a287707b01d05bb7ad6aadbe7d328">XOSD_IER_OFFSET</a>)) &amp; \</div>
<div class="line">                (<a class="code" href="group__osd__v4__0.html#ga09c0fe42f0cb0fe4a84e84acb6d548f3">XOsd_ReadReg</a>((InstancePtr)-&gt;Config.BaseAddress, \</div>
<div class="line">                        (<a class="code" href="group__osd__v4__0.html#gaee8b66db164a6929f9d75c1e75b6c4f7">XOSD_STATUS_OFFSET</a>))) &amp; (<a class="code" href="group__osd__v4__0.html#gaf0bcfced7a4f1a3f6069c73002ccb9aa">XOSD_IXR_ALLINTR_MASK</a>)</div>
<div class="ttc" id="group__osd__v4__0_html_gaf99a287707b01d05bb7ad6aadbe7d328"><div class="ttname"><a href="group__osd__v4__0.html#gaf99a287707b01d05bb7ad6aadbe7d328">XOSD_IER_OFFSET</a></div><div class="ttdeci">#define XOSD_IER_OFFSET</div><div class="ttdoc">Interrupt Enable Register Offset. </div><div class="ttdef"><b>Definition:</b> xosd_hw.h:150</div></div>
<div class="ttc" id="group__osd__v4__0_html_gaee8b66db164a6929f9d75c1e75b6c4f7"><div class="ttname"><a href="group__osd__v4__0.html#gaee8b66db164a6929f9d75c1e75b6c4f7">XOSD_STATUS_OFFSET</a></div><div class="ttdeci">#define XOSD_STATUS_OFFSET</div><div class="ttdoc">Status Offset. </div><div class="ttdef"><b>Definition:</b> xosd_hw.h:154</div></div>
<div class="ttc" id="group__osd__v4__0_html_ga09c0fe42f0cb0fe4a84e84acb6d548f3"><div class="ttname"><a href="group__osd__v4__0.html#ga09c0fe42f0cb0fe4a84e84acb6d548f3">XOsd_ReadReg</a></div><div class="ttdeci">#define XOsd_ReadReg(BaseAddress, RegOffset)</div><div class="ttdoc">This function reads the given register. </div><div class="ttdef"><b>Definition:</b> xosd_hw.h:829</div></div>
<div class="ttc" id="group__osd__v4__0_html_gaf0bcfced7a4f1a3f6069c73002ccb9aa"><div class="ttname"><a href="group__osd__v4__0.html#gaf0bcfced7a4f1a3f6069c73002ccb9aa">XOSD_IXR_ALLINTR_MASK</a></div><div class="ttdeci">#define XOSD_IXR_ALLINTR_MASK</div><div class="ttdoc">OR&#39;ing of all Masks. </div><div class="ttdef"><b>Definition:</b> xosd_hw.h:390</div></div>
</div><!-- fragment -->
<p>This function macro returns the pending interrupts of the OSD core. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_osd.html" title="The XOsd instance data. ">XOsd</a> instance to be worked on.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The pending interrupts of the OSD core. Use XOSD_IXR_*_MASK constants defined in <a class="el" href="xosd__hw_8h.html">xosd_hw.h</a> to interpret this value.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>C-style signature: u32 <a class="el" href="group__osd__v4__0.html#ga89fd83e071e7da016c89f9e155f1453a" title="This function macro returns the pending interrupts of the OSD core. ">XOsd_IntrGetPending(XOsd *InstancePtr)</a> </dd></dl>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#ga7079d6f5586ca603657dac6b9e188105">XOsd_IntrHandler()</a>.</p>

</div>
</div>
<a class="anchor" id="ga391290622b578053a6e4f87b94afe6d2"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_ISR_OFFSET&#160;&#160;&#160;<a class="el" href="group__osd__v4__0.html#gaee8b66db164a6929f9d75c1e75b6c4f7">XOSD_STATUS_OFFSET</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Interrupt status register generates a interrupt if the corresponding bits of interrupt enable register bits are set. </p>
<p>Interrupt Status Register Offset </p>

</div>
</div>
<a class="anchor" id="gaa0d5d1c04e53cea07f1f53e36485ca5e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_IXR_ALLERR_MASK</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>
<b>Value:</b><div class="fragment"><div class="line">(<a class="code" href="group__osd__v4__0.html#ga32ae9bfdbd5fbb3a8bfeb678ec477a5f">XOSD_IXR_LAYER0_ERROR_MASK</a> | <a class="code" href="group__osd__v4__0.html#ga1254380758b34648ac290aaad85ab5ed">\</a></div>
<div class="line"><a class="code" href="group__osd__v4__0.html#ga1254380758b34648ac290aaad85ab5ed">				XOSD_IXR_LAYER1_ERROR_MASK</a> | <a class="code" href="group__osd__v4__0.html#gaa1f661112594eca33ebd966fa2f3416b">\</a></div>
<div class="line"><a class="code" href="group__osd__v4__0.html#gaa1f661112594eca33ebd966fa2f3416b">				XOSD_IXR_LAYER2_ERROR_MASK</a> | <a class="code" href="group__osd__v4__0.html#ga3c2b866d2e5b926e20da7d0b211105a6">\</a></div>
<div class="line"><a class="code" href="group__osd__v4__0.html#ga3c2b866d2e5b926e20da7d0b211105a6">				XOSD_IXR_LAYER3_ERROR_MASK</a> | <a class="code" href="group__osd__v4__0.html#gaaf399127e81913ff3fb0cfac78cc9dea">\</a></div>
<div class="line"><a class="code" href="group__osd__v4__0.html#gaaf399127e81913ff3fb0cfac78cc9dea">				XOSD_IXR_LAYER4_ERROR_MASK</a> | <a class="code" href="group__osd__v4__0.html#gac204724cf271ed09f2f0c8d6ced5cb9c">\</a></div>
<div class="line"><a class="code" href="group__osd__v4__0.html#gac204724cf271ed09f2f0c8d6ced5cb9c">				XOSD_IXR_LAYER5_ERROR_MASK</a> | <a class="code" href="group__osd__v4__0.html#ga9febd5155dafb097e9b237c14cc7f50e">\</a></div>
<div class="line"><a class="code" href="group__osd__v4__0.html#ga9febd5155dafb097e9b237c14cc7f50e">				XOSD_IXR_LAYER6_ERROR_MASK</a> | <a class="code" href="group__osd__v4__0.html#ga447641c9b752868a28ecc3b835701222">\</a></div>
<div class="line"><a class="code" href="group__osd__v4__0.html#ga447641c9b752868a28ecc3b835701222">				XOSD_IXR_LAYER7_ERROR_MASK</a> )</div>
<div class="ttc" id="group__osd__v4__0_html_gac204724cf271ed09f2f0c8d6ced5cb9c"><div class="ttname"><a href="group__osd__v4__0.html#gac204724cf271ed09f2f0c8d6ced5cb9c">XOSD_IXR_LAYER5_ERROR_MASK</a></div><div class="ttdeci">#define XOSD_IXR_LAYER5_ERROR_MASK</div><div class="ttdoc">Layer 5 Error interrupt enable Mask. </div><div class="ttdef"><b>Definition:</b> xosd_hw.h:360</div></div>
<div class="ttc" id="group__osd__v4__0_html_ga3c2b866d2e5b926e20da7d0b211105a6"><div class="ttname"><a href="group__osd__v4__0.html#ga3c2b866d2e5b926e20da7d0b211105a6">XOSD_IXR_LAYER3_ERROR_MASK</a></div><div class="ttdeci">#define XOSD_IXR_LAYER3_ERROR_MASK</div><div class="ttdoc">Layer 3 Error interrupt enable Mask. </div><div class="ttdef"><b>Definition:</b> xosd_hw.h:350</div></div>
<div class="ttc" id="group__osd__v4__0_html_ga9febd5155dafb097e9b237c14cc7f50e"><div class="ttname"><a href="group__osd__v4__0.html#ga9febd5155dafb097e9b237c14cc7f50e">XOSD_IXR_LAYER6_ERROR_MASK</a></div><div class="ttdeci">#define XOSD_IXR_LAYER6_ERROR_MASK</div><div class="ttdoc">Layer 6 Error interrupt enable Mask. </div><div class="ttdef"><b>Definition:</b> xosd_hw.h:365</div></div>
<div class="ttc" id="group__osd__v4__0_html_ga1254380758b34648ac290aaad85ab5ed"><div class="ttname"><a href="group__osd__v4__0.html#ga1254380758b34648ac290aaad85ab5ed">XOSD_IXR_LAYER1_ERROR_MASK</a></div><div class="ttdeci">#define XOSD_IXR_LAYER1_ERROR_MASK</div><div class="ttdoc">Layer 1 Error interrupt enable Mask. </div><div class="ttdef"><b>Definition:</b> xosd_hw.h:340</div></div>
<div class="ttc" id="group__osd__v4__0_html_ga447641c9b752868a28ecc3b835701222"><div class="ttname"><a href="group__osd__v4__0.html#ga447641c9b752868a28ecc3b835701222">XOSD_IXR_LAYER7_ERROR_MASK</a></div><div class="ttdeci">#define XOSD_IXR_LAYER7_ERROR_MASK</div><div class="ttdoc">Layer 7 Error interrupt enable Mask. </div><div class="ttdef"><b>Definition:</b> xosd_hw.h:370</div></div>
<div class="ttc" id="group__osd__v4__0_html_ga32ae9bfdbd5fbb3a8bfeb678ec477a5f"><div class="ttname"><a href="group__osd__v4__0.html#ga32ae9bfdbd5fbb3a8bfeb678ec477a5f">XOSD_IXR_LAYER0_ERROR_MASK</a></div><div class="ttdeci">#define XOSD_IXR_LAYER0_ERROR_MASK</div><div class="ttdoc">Layer 0 Error interrupt enable Mask. </div><div class="ttdef"><b>Definition:</b> xosd_hw.h:335</div></div>
<div class="ttc" id="group__osd__v4__0_html_gaa1f661112594eca33ebd966fa2f3416b"><div class="ttname"><a href="group__osd__v4__0.html#gaa1f661112594eca33ebd966fa2f3416b">XOSD_IXR_LAYER2_ERROR_MASK</a></div><div class="ttdeci">#define XOSD_IXR_LAYER2_ERROR_MASK</div><div class="ttdoc">Layer 2 Error interrupt enable Mask. </div><div class="ttdef"><b>Definition:</b> xosd_hw.h:345</div></div>
<div class="ttc" id="group__osd__v4__0_html_gaaf399127e81913ff3fb0cfac78cc9dea"><div class="ttname"><a href="group__osd__v4__0.html#gaaf399127e81913ff3fb0cfac78cc9dea">XOSD_IXR_LAYER4_ERROR_MASK</a></div><div class="ttdeci">#define XOSD_IXR_LAYER4_ERROR_MASK</div><div class="ttdoc">Layer 4 Error interrupt enable Mask. </div><div class="ttdef"><b>Definition:</b> xosd_hw.h:355</div></div>
</div><!-- fragment -->
<p>OSD Layer 0 to Layer 7 Error Mask. </p>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#ga7079d6f5586ca603657dac6b9e188105">XOsd_IntrHandler()</a>.</p>

</div>
</div>
<a class="anchor" id="gaf0bcfced7a4f1a3f6069c73002ccb9aa"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_IXR_ALLINTR_MASK</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>
<b>Value:</b><div class="fragment"><div class="line">(<a class="code" href="group__osd__v4__0.html#gad2803dca6d21253c1cb2b5920b3f8eac">XOSD_IXR_PROC_STARTED_MASK</a> | <a class="code" href="group__osd__v4__0.html#ga0411b83937245d123c394afb37aa17f3">\</a></div>
<div class="line"><a class="code" href="group__osd__v4__0.html#ga0411b83937245d123c394afb37aa17f3">				XOSD_IXR_EOF_MASK</a> | <a class="code" href="group__osd__v4__0.html#gaa0d5d1c04e53cea07f1f53e36485ca5e">\</a></div>
<div class="line"><a class="code" href="group__osd__v4__0.html#gaa0d5d1c04e53cea07f1f53e36485ca5e">				XOSD_IXR_ALLERR_MASK</a>)</div>
<div class="ttc" id="group__osd__v4__0_html_gaa0d5d1c04e53cea07f1f53e36485ca5e"><div class="ttname"><a href="group__osd__v4__0.html#gaa0d5d1c04e53cea07f1f53e36485ca5e">XOSD_IXR_ALLERR_MASK</a></div><div class="ttdeci">#define XOSD_IXR_ALLERR_MASK</div><div class="ttdoc">OSD Layer 0 to Layer 7 Error Mask. </div><div class="ttdef"><b>Definition:</b> xosd_hw.h:379</div></div>
<div class="ttc" id="group__osd__v4__0_html_ga0411b83937245d123c394afb37aa17f3"><div class="ttname"><a href="group__osd__v4__0.html#ga0411b83937245d123c394afb37aa17f3">XOSD_IXR_EOF_MASK</a></div><div class="ttdeci">#define XOSD_IXR_EOF_MASK</div><div class="ttdoc">OSD End of frame mask. </div><div class="ttdef"><b>Definition:</b> xosd_hw.h:378</div></div>
<div class="ttc" id="group__osd__v4__0_html_gad2803dca6d21253c1cb2b5920b3f8eac"><div class="ttname"><a href="group__osd__v4__0.html#gad2803dca6d21253c1cb2b5920b3f8eac">XOSD_IXR_PROC_STARTED_MASK</a></div><div class="ttdeci">#define XOSD_IXR_PROC_STARTED_MASK</div><div class="ttdoc">OSD Processing started Mask. </div><div class="ttdef"><b>Definition:</b> xosd_hw.h:375</div></div>
</div><!-- fragment -->
<p>OR'ing of all Masks. </p>

</div>
</div>
<a class="anchor" id="ga0411b83937245d123c394afb37aa17f3"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_IXR_EOF_MASK&#160;&#160;&#160;0x00000002</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>OSD End of frame mask. </p>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#ga7079d6f5586ca603657dac6b9e188105">XOsd_IntrHandler()</a>.</p>

</div>
</div>
<a class="anchor" id="ga32ae9bfdbd5fbb3a8bfeb678ec477a5f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_IXR_LAYER0_ERROR_MASK&#160;&#160;&#160;0x00000010</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Layer 0 Error interrupt enable Mask. </p>

</div>
</div>
<a class="anchor" id="ga1254380758b34648ac290aaad85ab5ed"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_IXR_LAYER1_ERROR_MASK&#160;&#160;&#160;0x00000020</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Layer 1 Error interrupt enable Mask. </p>

</div>
</div>
<a class="anchor" id="gaa1f661112594eca33ebd966fa2f3416b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_IXR_LAYER2_ERROR_MASK&#160;&#160;&#160;0x00000040</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Layer 2 Error interrupt enable Mask. </p>

</div>
</div>
<a class="anchor" id="ga3c2b866d2e5b926e20da7d0b211105a6"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_IXR_LAYER3_ERROR_MASK&#160;&#160;&#160;0x00000080</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Layer 3 Error interrupt enable Mask. </p>

</div>
</div>
<a class="anchor" id="gaaf399127e81913ff3fb0cfac78cc9dea"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_IXR_LAYER4_ERROR_MASK&#160;&#160;&#160;0x00000100</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Layer 4 Error interrupt enable Mask. </p>

</div>
</div>
<a class="anchor" id="gac204724cf271ed09f2f0c8d6ced5cb9c"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_IXR_LAYER5_ERROR_MASK&#160;&#160;&#160;0x00000200</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Layer 5 Error interrupt enable Mask. </p>

</div>
</div>
<a class="anchor" id="ga9febd5155dafb097e9b237c14cc7f50e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_IXR_LAYER6_ERROR_MASK&#160;&#160;&#160;0x00000400</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Layer 6 Error interrupt enable Mask. </p>

</div>
</div>
<a class="anchor" id="ga447641c9b752868a28ecc3b835701222"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_IXR_LAYER7_ERROR_MASK&#160;&#160;&#160;0x00000800</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Layer 7 Error interrupt enable Mask. </p>

</div>
</div>
<a class="anchor" id="gad2803dca6d21253c1cb2b5920b3f8eac"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_IXR_PROC_STARTED_MASK&#160;&#160;&#160;0x00000001</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>OSD Processing started Mask. </p>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#ga7079d6f5586ca603657dac6b9e188105">XOsd_IntrHandler()</a>.</p>

</div>
</div>
<a class="anchor" id="gab825adfb1951ceab0492b842f71aacca"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_L0C_OFFSET&#160;&#160;&#160;0x110</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Layer 0 Control Offset. </p>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#ga1ecd1900b797b12867274e0daf1a8d62">XOsd_DisableLayer()</a>, <a class="el" href="group__osd__v4__0.html#gacdb4b75859dbfc611d70382fb2c94a7f">XOsd_EnableLayer()</a>, <a class="el" href="group__osd__v4__0.html#gab692eaddc144c270dfb05f7171c403e2">XOsd_GetLayerAlpha()</a>, <a class="el" href="group__osd__v4__0.html#ga3223d1726b2e25cda7de089d85353c1b">XOsd_GetLayerDimension()</a>, <a class="el" href="group__osd__v4__0.html#ga02cbaaa4f5e6b640c876b727db267602">XOsd_GetLayerPriority()</a>, <a class="el" href="group__osd__v4__0.html#ga08b6809a1bd0d27dd275e06fe1cbea61">XOsd_SetLayerAlpha()</a>, <a class="el" href="group__osd__v4__0.html#ga33679ac417b6f2596c6b6b085d39a5b1">XOsd_SetLayerDimension()</a>, and <a class="el" href="group__osd__v4__0.html#gae10e5b163cf71fd385200b724d1dd560">XOsd_SetLayerPriority()</a>.</p>

</div>
</div>
<a class="anchor" id="gabe519b825ff0b5a1d9dac15547940342"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_L0P_OFFSET&#160;&#160;&#160;0x114</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Layer 0 Position Offset. </p>

</div>
</div>
<a class="anchor" id="gaa161dd03025d073eb9327284e41582bd"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_L0S_OFFSET&#160;&#160;&#160;0x118</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Layer 0 Size Offset. </p>

</div>
</div>
<a class="anchor" id="ga70aa9e8b9ed2fe76fa2960152926afbe"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_L1C_OFFSET&#160;&#160;&#160;0x120</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Layer 1 Control Offset. </p>

</div>
</div>
<a class="anchor" id="ga8b5ae130a5dfd75c02fc0ccf2bd8b98f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_L1P_OFFSET&#160;&#160;&#160;0x124</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Layer 1 Position Offset. </p>

</div>
</div>
<a class="anchor" id="gaced9aba4cf986d847391c8c30ab19cc3"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_L1S_OFFSET&#160;&#160;&#160;0x128</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Layer 1 Size Offset. </p>

</div>
</div>
<a class="anchor" id="ga925d78cb14d70f8329cf243c8e0ce1ee"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_L2C_OFFSET&#160;&#160;&#160;0x130</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Layer 2 Control Offset. </p>

</div>
</div>
<a class="anchor" id="ga4ac6293832014e6d934caafcdbaae044"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_L2P_OFFSET&#160;&#160;&#160;0x134</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Layer 2 Position Offset. </p>

</div>
</div>
<a class="anchor" id="ga9af8d0e5b810ea58ecf281a2059c9934"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_L2S_OFFSET&#160;&#160;&#160;0x138</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Layer 2 Size Offset. </p>

</div>
</div>
<a class="anchor" id="gaf6d8e1e6148e2a91b2e95f1098fdec7f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_L3C_OFFSET&#160;&#160;&#160;0x140</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Layer 3 Control Offset. </p>

</div>
</div>
<a class="anchor" id="gaf234b25ab449a9ddc4f67c13a9f2087b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_L3P_OFFSET&#160;&#160;&#160;0x144</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Layer 3 Position Offset. </p>

</div>
</div>
<a class="anchor" id="ga6ae38a8780cdfbb444c70c7306401d1e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_L3S_OFFSET&#160;&#160;&#160;0x148</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Layer 3 Size Offset. </p>

</div>
</div>
<a class="anchor" id="gaf355de81e717afb5190ead6478446a10"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_L4C_OFFSET&#160;&#160;&#160;0x150</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Layer 4 Control Offset. </p>

</div>
</div>
<a class="anchor" id="gae524e8407dccba60543eacd4fb2b3c20"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_L4P_OFFSET&#160;&#160;&#160;0x154</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Layer 4 Position Offset. </p>

</div>
</div>
<a class="anchor" id="ga4717858c6b289e3e28d4346adfb699ad"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_L4S_OFFSET&#160;&#160;&#160;0x158</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Layer 4 Size Offset. </p>

</div>
</div>
<a class="anchor" id="ga6d9ca6883a9354270cf2ff7df52abb82"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_L5C_OFFSET&#160;&#160;&#160;0x160</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Layer 5 Control Offset. </p>

</div>
</div>
<a class="anchor" id="gab75a67c686efa89397e8b00f4aaa8817"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_L5P_OFFSET&#160;&#160;&#160;0x164</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Layer 5 Position Offset. </p>

</div>
</div>
<a class="anchor" id="gabd17ef37dfe5b050a08711228e73149f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_L5S_OFFSET&#160;&#160;&#160;0x168</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Layer 5 Size Offset. </p>

</div>
</div>
<a class="anchor" id="gacfe62f0aa69899d5e19bafa4032febe8"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_L6C_OFFSET&#160;&#160;&#160;0x170</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Layer 6 Control Offset. </p>

</div>
</div>
<a class="anchor" id="ga28048d90e31a2e44b244233c3d0624c1"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_L6P_OFFSET&#160;&#160;&#160;0x174</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Layer 6 Position Offset. </p>

</div>
</div>
<a class="anchor" id="gaa182c7c579413b0956ad34f3182487f9"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_L6S_OFFSET&#160;&#160;&#160;0x178</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Layer 6 Size Offset. </p>

</div>
</div>
<a class="anchor" id="ga375b3299a3ab6e962607996a1bb4995b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_L7C_OFFSET&#160;&#160;&#160;0x180</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Layer 7 Control Offset. </p>

</div>
</div>
<a class="anchor" id="ga9fd076860e53affe65c7cc8d8d13bf78"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_L7P_OFFSET&#160;&#160;&#160;0x184</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Layer 7 Position Offset. </p>

</div>
</div>
<a class="anchor" id="ga2dc4a8a41f7c1084bdc730adfbf8d42c"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_L7S_OFFSET&#160;&#160;&#160;0x188</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Layer 7 Size Offset. </p>

</div>
</div>
<a class="anchor" id="gad9b764d852dcdd0102fc01cedfac7684"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_LAYER_PRIORITY_0&#160;&#160;&#160;0</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Priority 0 &mdash; Lowest. </p>

</div>
</div>
<a class="anchor" id="ga932a406187d259e86449505a11e3692a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_LAYER_PRIORITY_1&#160;&#160;&#160;1</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Priority 1. </p>

</div>
</div>
<a class="anchor" id="ga15bda6688dc6f86f074be6971a97917d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_LAYER_PRIORITY_2&#160;&#160;&#160;2</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Priority 2. </p>

</div>
</div>
<a class="anchor" id="ga2f30a4bda0efa109c6a35606d3eb9879"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_LAYER_PRIORITY_3&#160;&#160;&#160;3</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Priority 3. </p>

</div>
</div>
<a class="anchor" id="ga1318d3cdd34c3814c23fb1421c1feb0a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_LAYER_PRIORITY_4&#160;&#160;&#160;4</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Priority 4. </p>

</div>
</div>
<a class="anchor" id="ga6d604585c04f43a69b2b0d6866d91910"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_LAYER_PRIORITY_5&#160;&#160;&#160;5</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Priority 5. </p>

</div>
</div>
<a class="anchor" id="gacda70be55f085349598127d3df04518a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_LAYER_PRIORITY_6&#160;&#160;&#160;6</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Priority 6. </p>

</div>
</div>
<a class="anchor" id="gaa7258407b41c68c30777e966937118ba"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_LAYER_PRIORITY_7&#160;&#160;&#160;7</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Priority 7 &mdash; Highest. </p>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#gae10e5b163cf71fd385200b724d1dd560">XOsd_SetLayerPriority()</a>.</p>

</div>
</div>
<a class="anchor" id="ga59528981053fa8883db1b0b897ca0c06"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_LAYER_SIZE&#160;&#160;&#160;0x10</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Total number of Layers. </p>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#ga1ecd1900b797b12867274e0daf1a8d62">XOsd_DisableLayer()</a>, <a class="el" href="group__osd__v4__0.html#gacdb4b75859dbfc611d70382fb2c94a7f">XOsd_EnableLayer()</a>, <a class="el" href="group__osd__v4__0.html#gab692eaddc144c270dfb05f7171c403e2">XOsd_GetLayerAlpha()</a>, <a class="el" href="group__osd__v4__0.html#ga3223d1726b2e25cda7de089d85353c1b">XOsd_GetLayerDimension()</a>, <a class="el" href="group__osd__v4__0.html#ga02cbaaa4f5e6b640c876b727db267602">XOsd_GetLayerPriority()</a>, <a class="el" href="group__osd__v4__0.html#ga08b6809a1bd0d27dd275e06fe1cbea61">XOsd_SetLayerAlpha()</a>, <a class="el" href="group__osd__v4__0.html#ga33679ac417b6f2596c6b6b085d39a5b1">XOsd_SetLayerDimension()</a>, and <a class="el" href="group__osd__v4__0.html#gae10e5b163cf71fd385200b724d1dd560">XOsd_SetLayerPriority()</a>.</p>

</div>
</div>
<a class="anchor" id="gaaaab169a7980313aad002f2301cd8023"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_LAYER_TYPE_DISABLE&#160;&#160;&#160;0</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Layer is disabled. </p>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#ga1ecd1900b797b12867274e0daf1a8d62">XOsd_DisableLayer()</a>, <a class="el" href="group__osd__v4__0.html#gacdb4b75859dbfc611d70382fb2c94a7f">XOsd_EnableLayer()</a>, <a class="el" href="group__osd__v4__0.html#gab692eaddc144c270dfb05f7171c403e2">XOsd_GetLayerAlpha()</a>, <a class="el" href="group__osd__v4__0.html#ga3223d1726b2e25cda7de089d85353c1b">XOsd_GetLayerDimension()</a>, <a class="el" href="group__osd__v4__0.html#ga02cbaaa4f5e6b640c876b727db267602">XOsd_GetLayerPriority()</a>, <a class="el" href="group__osd__v4__0.html#ga08b6809a1bd0d27dd275e06fe1cbea61">XOsd_SetLayerAlpha()</a>, <a class="el" href="group__osd__v4__0.html#ga33679ac417b6f2596c6b6b085d39a5b1">XOsd_SetLayerDimension()</a>, and <a class="el" href="group__osd__v4__0.html#gae10e5b163cf71fd385200b724d1dd560">XOsd_SetLayerPriority()</a>.</p>

</div>
</div>
<a class="anchor" id="ga5b24c90cd1ba5772581eb7b743d2abe9"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_LAYER_TYPE_GPU&#160;&#160;&#160;1</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Layer's type is GPU. </p>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#ga7abff2415587a54c259f159fc780e2cc">XOsd_CreateInstruction()</a>, <a class="el" href="group__osd__v4__0.html#ga6579cb01322e477e72faec9ea6feee63">XOsd_LoadCharacterSetBank()</a>, <a class="el" href="group__osd__v4__0.html#ga9d28c4453d039dc09b540d55c78c80b2">XOsd_LoadColorLUTBank()</a>, <a class="el" href="group__osd__v4__0.html#ga55937cb3259f5843c9e1beec4e126955">XOsd_LoadInstructionList()</a>, <a class="el" href="group__osd__v4__0.html#ga5a76210dc91d4a51111855bbc501c4e8">XOsd_LoadTextBank()</a>, and <a class="el" href="group__osd__v4__0.html#ga5552532bfdfcd272722180e71d6c7b75">XOsd_SetActiveBank()</a>.</p>

</div>
</div>
<a class="anchor" id="ga50ef709588ee8a929cbfbd6215d63605"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_LAYER_TYPE_VFBC&#160;&#160;&#160;2</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Layer's type is VFBC. </p>

</div>
</div>
<a class="anchor" id="gaa7a4a31d3453e33f287b1be4ac4dd866"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_LXC&#160;&#160;&#160;0x00</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Layer Control. </p>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#ga1ecd1900b797b12867274e0daf1a8d62">XOsd_DisableLayer()</a>, <a class="el" href="group__osd__v4__0.html#gacdb4b75859dbfc611d70382fb2c94a7f">XOsd_EnableLayer()</a>, <a class="el" href="group__osd__v4__0.html#gab692eaddc144c270dfb05f7171c403e2">XOsd_GetLayerAlpha()</a>, <a class="el" href="group__osd__v4__0.html#ga02cbaaa4f5e6b640c876b727db267602">XOsd_GetLayerPriority()</a>, <a class="el" href="group__osd__v4__0.html#ga08b6809a1bd0d27dd275e06fe1cbea61">XOsd_SetLayerAlpha()</a>, and <a class="el" href="group__osd__v4__0.html#gae10e5b163cf71fd385200b724d1dd560">XOsd_SetLayerPriority()</a>.</p>

</div>
</div>
<a class="anchor" id="gad95aafec82b865159f52e65949c23529"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_LXC_ALPHA_MASK&#160;&#160;&#160;0x1FFF0000</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Global Alpha Value Mask. </p>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#gab692eaddc144c270dfb05f7171c403e2">XOsd_GetLayerAlpha()</a>, and <a class="el" href="group__osd__v4__0.html#ga08b6809a1bd0d27dd275e06fe1cbea61">XOsd_SetLayerAlpha()</a>.</p>

</div>
</div>
<a class="anchor" id="ga8b9042e82d8df689be0036e9ede471f2"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_LXC_ALPHA_SHIFT&#160;&#160;&#160;16</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Bit shift number of Global Alpha Value. </p>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#gab692eaddc144c270dfb05f7171c403e2">XOsd_GetLayerAlpha()</a>, and <a class="el" href="group__osd__v4__0.html#ga08b6809a1bd0d27dd275e06fe1cbea61">XOsd_SetLayerAlpha()</a>.</p>

</div>
</div>
<a class="anchor" id="ga222fb398c40df639f9dfdb9ccdf67964"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_LXC_EN_MASK&#160;&#160;&#160;0x00000001</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Layer Enable Mask. </p>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#ga1ecd1900b797b12867274e0daf1a8d62">XOsd_DisableLayer()</a>, and <a class="el" href="group__osd__v4__0.html#gacdb4b75859dbfc611d70382fb2c94a7f">XOsd_EnableLayer()</a>.</p>

</div>
</div>
<a class="anchor" id="gabe784eba2fa547d6a70591efa719dd16"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_LXC_GALPHAEN_MASK&#160;&#160;&#160;0x00000002</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Global Alpha Enable Mask. </p>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#gab692eaddc144c270dfb05f7171c403e2">XOsd_GetLayerAlpha()</a>, and <a class="el" href="group__osd__v4__0.html#ga08b6809a1bd0d27dd275e06fe1cbea61">XOsd_SetLayerAlpha()</a>.</p>

</div>
</div>
<a class="anchor" id="gae1e09e803eb566221f3ad1ea9544534a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_LXC_PRIORITY_MASK&#160;&#160;&#160;0x00000700</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Layer Priority Mask. </p>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#ga02cbaaa4f5e6b640c876b727db267602">XOsd_GetLayerPriority()</a>, and <a class="el" href="group__osd__v4__0.html#gae10e5b163cf71fd385200b724d1dd560">XOsd_SetLayerPriority()</a>.</p>

</div>
</div>
<a class="anchor" id="ga2d7d038fb2a5bdf668dc3e39961e7644"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_LXC_PRIORITY_SHIFT&#160;&#160;&#160;8</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Bit shift number of Layer Priority. </p>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#ga02cbaaa4f5e6b640c876b727db267602">XOsd_GetLayerPriority()</a>, and <a class="el" href="group__osd__v4__0.html#gae10e5b163cf71fd385200b724d1dd560">XOsd_SetLayerPriority()</a>.</p>

</div>
</div>
<a class="anchor" id="ga06bbfe6e69f2747df8d5260827f588fa"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_LXP&#160;&#160;&#160;0x04</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Layer Position. </p>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#ga3223d1726b2e25cda7de089d85353c1b">XOsd_GetLayerDimension()</a>, and <a class="el" href="group__osd__v4__0.html#ga33679ac417b6f2596c6b6b085d39a5b1">XOsd_SetLayerDimension()</a>.</p>

</div>
</div>
<a class="anchor" id="ga54711c94080d9bc076195b0747729856"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_LXP_XSTART_MASK&#160;&#160;&#160;0x00000FFF</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Horizontal start pixel of origin of layer Mask. </p>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#ga3223d1726b2e25cda7de089d85353c1b">XOsd_GetLayerDimension()</a>, and <a class="el" href="group__osd__v4__0.html#ga33679ac417b6f2596c6b6b085d39a5b1">XOsd_SetLayerDimension()</a>.</p>

</div>
</div>
<a class="anchor" id="ga7c23d1cec7d28b5ac5c8632fe602bf9c"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_LXP_YSTART_MASK&#160;&#160;&#160;0x0FFF0000</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Vertical start line of origin of layer Mask. </p>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#ga3223d1726b2e25cda7de089d85353c1b">XOsd_GetLayerDimension()</a>, and <a class="el" href="group__osd__v4__0.html#ga33679ac417b6f2596c6b6b085d39a5b1">XOsd_SetLayerDimension()</a>.</p>

</div>
</div>
<a class="anchor" id="gac828bb35053a7d8f8ecfc27766ec6703"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_LXP_YSTART_SHIFT&#160;&#160;&#160;16</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Bit shift of vertical start line of origin of layer. </p>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#ga3223d1726b2e25cda7de089d85353c1b">XOsd_GetLayerDimension()</a>, and <a class="el" href="group__osd__v4__0.html#ga33679ac417b6f2596c6b6b085d39a5b1">XOsd_SetLayerDimension()</a>.</p>

</div>
</div>
<a class="anchor" id="ga1679b9fa0d6170817f443a7c24c10a62"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_LXS&#160;&#160;&#160;0x08</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Layer Size. </p>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#ga3223d1726b2e25cda7de089d85353c1b">XOsd_GetLayerDimension()</a>, and <a class="el" href="group__osd__v4__0.html#ga33679ac417b6f2596c6b6b085d39a5b1">XOsd_SetLayerDimension()</a>.</p>

</div>
</div>
<a class="anchor" id="ga0ce8e4abc1669f61786c556bb496a471"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_LXS_XSIZE_MASK&#160;&#160;&#160;0x00000FFF</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Horizontal size of layer Mask. </p>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#ga3223d1726b2e25cda7de089d85353c1b">XOsd_GetLayerDimension()</a>, and <a class="el" href="group__osd__v4__0.html#ga33679ac417b6f2596c6b6b085d39a5b1">XOsd_SetLayerDimension()</a>.</p>

</div>
</div>
<a class="anchor" id="ga1a19bab0f8bae1dbbfe591ad6338757a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_LXS_YSIZE_MASK&#160;&#160;&#160;0x0FFF0000</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Vertical size of layer Mask. </p>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#ga3223d1726b2e25cda7de089d85353c1b">XOsd_GetLayerDimension()</a>, and <a class="el" href="group__osd__v4__0.html#ga33679ac417b6f2596c6b6b085d39a5b1">XOsd_SetLayerDimension()</a>.</p>

</div>
</div>
<a class="anchor" id="ga3b683ef20fa0d1f9d9dfca72fe9bed28"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_LXS_YSIZE_SHIFT&#160;&#160;&#160;16</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Bit shift number of vertical size of layer. </p>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#ga3223d1726b2e25cda7de089d85353c1b">XOsd_GetLayerDimension()</a>, and <a class="el" href="group__osd__v4__0.html#ga33679ac417b6f2596c6b6b085d39a5b1">XOsd_SetLayerDimension()</a>.</p>

</div>
</div>
<a class="anchor" id="ga9bbf9f4ac7f8a29a4666da1eaa076089"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_MAX_NUM_OF_LAYERS&#160;&#160;&#160;8</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>The max number of layers. </p>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#gaf9dad59565307cd8f71b385689f91048">XOsd_CfgInitialize()</a>.</p>

</div>
</div>
<a class="anchor" id="gaaa6093725b9f6e7f4b8d4badd4a383b1"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_OPENC_NBITS_MASK&#160;&#160;&#160;0x00000030</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Vertical Height of OSD Output Mask. </p>

</div>
</div>
<a class="anchor" id="ga88c638d281a3d1e03af771b1d52089f9"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_OPENC_OFFSET&#160;&#160;&#160;0x028</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Output Encoding Offset. </p>

</div>
</div>
<a class="anchor" id="ga755bedd632dc7d9005afc8b451402c59"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_OPENC_VID_FORMAT_MASK&#160;&#160;&#160;0x0000000F</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>OSD Output Video Format Mask 0: YUV 4:2:2 1: YUV 4:4:4 2: RGB 3: YUV 4:2:0. </p>

</div>
</div>
<a class="anchor" id="ga09c0fe42f0cb0fe4a84e84acb6d548f3"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOsd_ReadReg</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">BaseAddress, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">RegOffset&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td>&#160;&#160;&#160;XOsd_In32((BaseAddress) + (u32)(RegOffset))</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>This function reads the given register. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">BaseAddress</td><td>is the base address of the OSD core. </td></tr>
    <tr><td class="paramname">RegOffset</td><td>is the register offset of the OSD core.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The 32-bit value of the register.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>C-style signature: u32 <a class="el" href="group__osd__v4__0.html#ga09c0fe42f0cb0fe4a84e84acb6d548f3" title="This function reads the given register. ">XOsd_ReadReg(u32 BaseAddress, u32 RegOffset)</a> </dd></dl>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#ga1ecd1900b797b12867274e0daf1a8d62">XOsd_DisableLayer()</a>, <a class="el" href="group__osd__v4__0.html#gacdb4b75859dbfc611d70382fb2c94a7f">XOsd_EnableLayer()</a>, <a class="el" href="group__osd__v4__0.html#gafad06669f4df698b225bfe8b05e6dbbd">XOsd_GetActiveSize()</a>, <a class="el" href="group__osd__v4__0.html#gaa7361c792b36dafe0e48ae22c32cf125">XOsd_GetBackgroundColor()</a>, <a class="el" href="group__osd__v4__0.html#gab692eaddc144c270dfb05f7171c403e2">XOsd_GetLayerAlpha()</a>, <a class="el" href="group__osd__v4__0.html#ga3223d1726b2e25cda7de089d85353c1b">XOsd_GetLayerDimension()</a>, <a class="el" href="group__osd__v4__0.html#ga02cbaaa4f5e6b640c876b727db267602">XOsd_GetLayerPriority()</a>, <a class="el" href="group__osd__v4__0.html#ga94b9d7eac70a2fc2315b07059e832986">XOsd_GetVersion()</a>, <a class="el" href="group__osd__v4__0.html#ga6579cb01322e477e72faec9ea6feee63">XOsd_LoadCharacterSetBank()</a>, <a class="el" href="group__osd__v4__0.html#ga9d28c4453d039dc09b540d55c78c80b2">XOsd_LoadColorLUTBank()</a>, <a class="el" href="group__osd__v4__0.html#ga55937cb3259f5843c9e1beec4e126955">XOsd_LoadInstructionList()</a>, <a class="el" href="group__osd__v4__0.html#ga5a76210dc91d4a51111855bbc501c4e8">XOsd_LoadTextBank()</a>, <a class="el" href="group__osd__v4__0.html#ga8a5fad0300d0413161f50c5df445a08f">XOsd_SelfTest()</a>, <a class="el" href="group__osd__v4__0.html#ga5552532bfdfcd272722180e71d6c7b75">XOsd_SetActiveBank()</a>, <a class="el" href="group__osd__v4__0.html#ga08b6809a1bd0d27dd275e06fe1cbea61">XOsd_SetLayerAlpha()</a>, and <a class="el" href="group__osd__v4__0.html#gae10e5b163cf71fd385200b724d1dd560">XOsd_SetLayerPriority()</a>.</p>

</div>
</div>
<a class="anchor" id="gacf3d6dd9a30650e586a89cbbfa2f0e1a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOsd_RegUpdateDisable</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">InstancePtr</td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd_8h.html">xosd.h</a>&gt;</code></p>
<b>Value:</b><div class="fragment"><div class="line"><a class="code" href="group__osd__v4__0.html#ga37791d01d7ba72baa57bd45c2744a6b7">XOsd_WriteReg</a>((InstancePtr)-&gt;Config.BaseAddress, (<a class="code" href="group__osd__v4__0.html#gaa5d6b91c6ac72faf3a38044153f373d4">XOSD_CTL_OFFSET</a>), \</div>
<div class="line">                ((<a class="code" href="group__osd__v4__0.html#ga09c0fe42f0cb0fe4a84e84acb6d548f3">XOsd_ReadReg</a>((InstancePtr)-&gt;Config.BaseAddress, \</div>
<div class="line">                        (<a class="code" href="group__osd__v4__0.html#gaa5d6b91c6ac72faf3a38044153f373d4">XOSD_CTL_OFFSET</a>))) &amp; (~(<a class="code" href="group__osd__v4__0.html#ga75f6be92e492fb0a76e9f530939467af">XOSD_CTL_RUE_MASK</a>))))</div>
<div class="ttc" id="group__osd__v4__0_html_ga09c0fe42f0cb0fe4a84e84acb6d548f3"><div class="ttname"><a href="group__osd__v4__0.html#ga09c0fe42f0cb0fe4a84e84acb6d548f3">XOsd_ReadReg</a></div><div class="ttdeci">#define XOsd_ReadReg(BaseAddress, RegOffset)</div><div class="ttdoc">This function reads the given register. </div><div class="ttdef"><b>Definition:</b> xosd_hw.h:829</div></div>
<div class="ttc" id="group__osd__v4__0_html_ga37791d01d7ba72baa57bd45c2744a6b7"><div class="ttname"><a href="group__osd__v4__0.html#ga37791d01d7ba72baa57bd45c2744a6b7">XOsd_WriteReg</a></div><div class="ttdeci">#define XOsd_WriteReg(BaseAddress, RegOffset, Data)</div><div class="ttdoc">This function writes the given register. </div><div class="ttdef"><b>Definition:</b> xosd_hw.h:847</div></div>
<div class="ttc" id="group__osd__v4__0_html_gaa5d6b91c6ac72faf3a38044153f373d4"><div class="ttname"><a href="group__osd__v4__0.html#gaa5d6b91c6ac72faf3a38044153f373d4">XOSD_CTL_OFFSET</a></div><div class="ttdeci">#define XOSD_CTL_OFFSET</div><div class="ttdoc">Control Offset. </div><div class="ttdef"><b>Definition:</b> xosd_hw.h:90</div></div>
<div class="ttc" id="group__osd__v4__0_html_ga75f6be92e492fb0a76e9f530939467af"><div class="ttname"><a href="group__osd__v4__0.html#ga75f6be92e492fb0a76e9f530939467af">XOSD_CTL_RUE_MASK</a></div><div class="ttdeci">#define XOSD_CTL_RUE_MASK</div><div class="ttdoc">Register Update Enable Mask. </div><div class="ttdef"><b>Definition:</b> xosd_hw.h:729</div></div>
</div><!-- fragment -->
<p>This function macro prevents the OSD core from committing recent changes made so far by the software. </p>
<p>When disabled, changes to other configuration registers are stored, but do not effect the behavior of the core.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_osd.html" title="The XOsd instance data. ">XOsd</a> instance to be worked on.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>C-style signature: void <a class="el" href="group__osd__v4__0.html#gacf3d6dd9a30650e586a89cbbfa2f0e1a" title="This function macro prevents the OSD core from committing recent changes made so far by the software...">XOsd_RegUpdateDisable(XOsd *InstancePtr)</a> </dd></dl>

</div>
</div>
<a class="anchor" id="gace1507486db80db018b62df611dbe0d6"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOsd_RegUpdateEnable</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">InstancePtr</td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd_8h.html">xosd.h</a>&gt;</code></p>
<b>Value:</b><div class="fragment"><div class="line"><a class="code" href="group__osd__v4__0.html#ga37791d01d7ba72baa57bd45c2744a6b7">XOsd_WriteReg</a>((InstancePtr)-&gt;Config.BaseAddress, (<a class="code" href="group__osd__v4__0.html#gaa5d6b91c6ac72faf3a38044153f373d4">XOSD_CTL_OFFSET</a>), \</div>
<div class="line">                ((<a class="code" href="group__osd__v4__0.html#ga09c0fe42f0cb0fe4a84e84acb6d548f3">XOsd_ReadReg</a>((InstancePtr)-&gt;Config.BaseAddress, \</div>
<div class="line">                        (<a class="code" href="group__osd__v4__0.html#gaa5d6b91c6ac72faf3a38044153f373d4">XOSD_CTL_OFFSET</a>))) | (<a class="code" href="group__osd__v4__0.html#ga75f6be92e492fb0a76e9f530939467af">XOSD_CTL_RUE_MASK</a>)))</div>
<div class="ttc" id="group__osd__v4__0_html_ga09c0fe42f0cb0fe4a84e84acb6d548f3"><div class="ttname"><a href="group__osd__v4__0.html#ga09c0fe42f0cb0fe4a84e84acb6d548f3">XOsd_ReadReg</a></div><div class="ttdeci">#define XOsd_ReadReg(BaseAddress, RegOffset)</div><div class="ttdoc">This function reads the given register. </div><div class="ttdef"><b>Definition:</b> xosd_hw.h:829</div></div>
<div class="ttc" id="group__osd__v4__0_html_ga37791d01d7ba72baa57bd45c2744a6b7"><div class="ttname"><a href="group__osd__v4__0.html#ga37791d01d7ba72baa57bd45c2744a6b7">XOsd_WriteReg</a></div><div class="ttdeci">#define XOsd_WriteReg(BaseAddress, RegOffset, Data)</div><div class="ttdoc">This function writes the given register. </div><div class="ttdef"><b>Definition:</b> xosd_hw.h:847</div></div>
<div class="ttc" id="group__osd__v4__0_html_gaa5d6b91c6ac72faf3a38044153f373d4"><div class="ttname"><a href="group__osd__v4__0.html#gaa5d6b91c6ac72faf3a38044153f373d4">XOSD_CTL_OFFSET</a></div><div class="ttdeci">#define XOSD_CTL_OFFSET</div><div class="ttdoc">Control Offset. </div><div class="ttdef"><b>Definition:</b> xosd_hw.h:90</div></div>
<div class="ttc" id="group__osd__v4__0_html_ga75f6be92e492fb0a76e9f530939467af"><div class="ttname"><a href="group__osd__v4__0.html#ga75f6be92e492fb0a76e9f530939467af">XOSD_CTL_RUE_MASK</a></div><div class="ttdeci">#define XOSD_CTL_RUE_MASK</div><div class="ttdoc">Register Update Enable Mask. </div><div class="ttdef"><b>Definition:</b> xosd_hw.h:729</div></div>
</div><!-- fragment -->
<p>This function macro commits all the register value changes made so far by the software to the OSD core instance. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_osd.html" title="The XOsd instance data. ">XOsd</a> instance to be worked on.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>C-style signature: void <a class="el" href="group__osd__v4__0.html#gace1507486db80db018b62df611dbe0d6" title="This function macro commits all the register value changes made so far by the software to the OSD cor...">XOsd_RegUpdateEnable(XOsd *InstancePtr)</a> </dd></dl>

</div>
</div>
<a class="anchor" id="ga2ccc3d88129121707113a37dd1a7dea8"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOsd_Reset</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">InstancePtr</td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd_8h.html">xosd.h</a>&gt;</code></p>
<b>Value:</b><div class="fragment"><div class="line">{ <a class="code" href="group__osd__v4__0.html#ga37791d01d7ba72baa57bd45c2744a6b7">\</a></div>
<div class="line"><a class="code" href="group__osd__v4__0.html#ga37791d01d7ba72baa57bd45c2744a6b7">	XOsd_WriteReg</a>((InstancePtr)-&gt;Config.BaseAddress, (<a class="code" href="group__osd__v4__0.html#gaa5d6b91c6ac72faf3a38044153f373d4">XOSD_CTL_OFFSET</a>), \</div>
<div class="line">                (<a class="code" href="group__osd__v4__0.html#ga5071d9f484bd2b71197794e55ccdd92e">XOSD_CTL_SW_RST_MASK</a>)); \</div>
<div class="line">        (InstancePtr)-&gt;InstructionInExternalMem = (u32)0x0; \</div>
<div class="line">        (InstancePtr)-&gt;ScreenHeight = (u32)0x0; \</div>
<div class="line">        (InstancePtr)-&gt;ScreenWidth = (u32)0x0; \</div>
<div class="line">}</div>
<div class="ttc" id="group__osd__v4__0_html_ga37791d01d7ba72baa57bd45c2744a6b7"><div class="ttname"><a href="group__osd__v4__0.html#ga37791d01d7ba72baa57bd45c2744a6b7">XOsd_WriteReg</a></div><div class="ttdeci">#define XOsd_WriteReg(BaseAddress, RegOffset, Data)</div><div class="ttdoc">This function writes the given register. </div><div class="ttdef"><b>Definition:</b> xosd_hw.h:847</div></div>
<div class="ttc" id="group__osd__v4__0_html_gaa5d6b91c6ac72faf3a38044153f373d4"><div class="ttname"><a href="group__osd__v4__0.html#gaa5d6b91c6ac72faf3a38044153f373d4">XOSD_CTL_OFFSET</a></div><div class="ttdeci">#define XOSD_CTL_OFFSET</div><div class="ttdoc">Control Offset. </div><div class="ttdef"><b>Definition:</b> xosd_hw.h:90</div></div>
<div class="ttc" id="group__osd__v4__0_html_ga5071d9f484bd2b71197794e55ccdd92e"><div class="ttname"><a href="group__osd__v4__0.html#ga5071d9f484bd2b71197794e55ccdd92e">XOSD_CTL_SW_RST_MASK</a></div><div class="ttdeci">#define XOSD_CTL_SW_RST_MASK</div><div class="ttdoc">Core Reset Mask. </div><div class="ttdef"><b>Definition:</b> xosd_hw.h:733</div></div>
</div><!-- fragment -->
<p>This function macro resets an OSD core This effects the core immediately, and may cause image tearing. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_osd.html" title="The XOsd instance data. ">XOsd</a> instance to be worked on.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>C-style signature: void <a class="el" href="group__osd__v4__0.html#ga2ccc3d88129121707113a37dd1a7dea8" title="This function macro resets an OSD core This effects the core immediately, and may cause image tearing...">XOsd_Reset(XOsd *InstancePtr)</a> This bit automatically clears when reset complete. </dd></dl>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#gaf9dad59565307cd8f71b385689f91048">XOsd_CfgInitialize()</a>.</p>

</div>
</div>
<a class="anchor" id="ga3e1d00b23577b666a2f91a563f56f7f4"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_RST_OFFSET&#160;&#160;&#160;<a class="el" href="group__osd__v4__0.html#gaa5d6b91c6ac72faf3a38044153f373d4">XOSD_CTL_OFFSET</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Software Reset Offset. </p>

</div>
</div>
<a class="anchor" id="gaea23e38f10971419aa4e85b033332617"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_RST_RESET&#160;&#160;&#160;<a class="el" href="group__osd__v4__0.html#ga5071d9f484bd2b71197794e55ccdd92e">XOSD_CTL_SW_RST_MASK</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Software Reset. </p>

</div>
</div>
<a class="anchor" id="ga44aa3036799de8b96c61143abf156b02"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOsd_Start&#160;&#160;&#160;<a class="el" href="group__osd__v4__0.html#gae6e41c067d999ee6cdc29d3868ec8be8">XOsd_Enable</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd_8h.html">xosd.h</a>&gt;</code></p>

<p>This function macro stops an OSD core. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_osd.html" title="The XOsd instance data. ">XOsd</a> instance to be worked on.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>C-style signature: void <a class="el" href="group__osd__v4__0.html#ga44aa3036799de8b96c61143abf156b02" title="This function macro stops an OSD core. ">XOsd_Start(XOsd *InstancePtr)</a> </dd></dl>

</div>
</div>
<a class="anchor" id="gaee8b66db164a6929f9d75c1e75b6c4f7"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_STATUS_OFFSET&#160;&#160;&#160;0x004</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Status Offset. </p>

</div>
</div>
<a class="anchor" id="ga2e2425a5c7b56573e9fdc833f89843f0"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOsd_StatusGetPending</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">InstancePtr</td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd_8h.html">xosd.h</a>&gt;</code></p>
<b>Value:</b><div class="fragment"><div class="line"><a class="code" href="group__osd__v4__0.html#ga09c0fe42f0cb0fe4a84e84acb6d548f3">XOsd_ReadReg</a>((InstancePtr)-&gt;Config.BaseAddress, \</div>
<div class="line">                (<a class="code" href="group__osd__v4__0.html#gaee8b66db164a6929f9d75c1e75b6c4f7">XOSD_STATUS_OFFSET</a>)) &amp; (<a class="code" href="group__osd__v4__0.html#gaf0bcfced7a4f1a3f6069c73002ccb9aa">XOSD_IXR_ALLINTR_MASK</a>)</div>
<div class="ttc" id="group__osd__v4__0_html_gaee8b66db164a6929f9d75c1e75b6c4f7"><div class="ttname"><a href="group__osd__v4__0.html#gaee8b66db164a6929f9d75c1e75b6c4f7">XOSD_STATUS_OFFSET</a></div><div class="ttdeci">#define XOSD_STATUS_OFFSET</div><div class="ttdoc">Status Offset. </div><div class="ttdef"><b>Definition:</b> xosd_hw.h:154</div></div>
<div class="ttc" id="group__osd__v4__0_html_ga09c0fe42f0cb0fe4a84e84acb6d548f3"><div class="ttname"><a href="group__osd__v4__0.html#ga09c0fe42f0cb0fe4a84e84acb6d548f3">XOsd_ReadReg</a></div><div class="ttdeci">#define XOsd_ReadReg(BaseAddress, RegOffset)</div><div class="ttdoc">This function reads the given register. </div><div class="ttdef"><b>Definition:</b> xosd_hw.h:829</div></div>
<div class="ttc" id="group__osd__v4__0_html_gaf0bcfced7a4f1a3f6069c73002ccb9aa"><div class="ttname"><a href="group__osd__v4__0.html#gaf0bcfced7a4f1a3f6069c73002ccb9aa">XOSD_IXR_ALLINTR_MASK</a></div><div class="ttdeci">#define XOSD_IXR_ALLINTR_MASK</div><div class="ttdoc">OR&#39;ing of all Masks. </div><div class="ttdef"><b>Definition:</b> xosd_hw.h:390</div></div>
</div><!-- fragment -->
<p>This function macro returns the pending status of the OSD core. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_osd.html" title="The XOsd instance data. ">XOsd</a> instance to be worked on.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The pending interrupts of the OSD. Use XOSD_IXR_* constants defined in <a class="el" href="xosd__hw_8h.html">xosd_hw.h</a> to interpret this value.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>C-style signature: u32 XOsd_StatusGePending(XOsd *InstancePtr) </dd></dl>

</div>
</div>
<a class="anchor" id="ga9e08f021a97bc835d659b08b57dc4b5a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOsd_Stop&#160;&#160;&#160;<a class="el" href="group__osd__v4__0.html#ga2a84453f73f690e671aa3b2ede645fb0">XOsd_Disable</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd_8h.html">xosd.h</a>&gt;</code></p>

<p>This function macro stops an OSD core. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_osd.html" title="The XOsd instance data. ">XOsd</a> instance to be worked on.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>C-style signature: void <a class="el" href="group__osd__v4__0.html#ga9e08f021a97bc835d659b08b57dc4b5a" title="This function macro stops an OSD core. ">XOsd_Stop(XOsd *InstancePtr)</a> </dd></dl>

</div>
</div>
<a class="anchor" id="ga3a758a90dded736022ab70e7c0be8796"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOsd_SyncReset</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">InstancePtr</td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd_8h.html">xosd.h</a>&gt;</code></p>
<b>Value:</b><div class="fragment"><div class="line"><a class="code" href="group__osd__v4__0.html#ga37791d01d7ba72baa57bd45c2744a6b7">XOsd_WriteReg</a>((InstancePtr)-&gt;Config.BaseAddress, (<a class="code" href="group__osd__v4__0.html#gaa5d6b91c6ac72faf3a38044153f373d4">XOSD_CTL_OFFSET</a>), \</div>
<div class="line">                (<a class="code" href="group__osd__v4__0.html#ga68088d2cf45788126489895482f52276">XOSD_CTL_FSYNC_MASK</a>))</div>
<div class="ttc" id="group__osd__v4__0_html_ga37791d01d7ba72baa57bd45c2744a6b7"><div class="ttname"><a href="group__osd__v4__0.html#ga37791d01d7ba72baa57bd45c2744a6b7">XOsd_WriteReg</a></div><div class="ttdeci">#define XOsd_WriteReg(BaseAddress, RegOffset, Data)</div><div class="ttdoc">This function writes the given register. </div><div class="ttdef"><b>Definition:</b> xosd_hw.h:847</div></div>
<div class="ttc" id="group__osd__v4__0_html_gaa5d6b91c6ac72faf3a38044153f373d4"><div class="ttname"><a href="group__osd__v4__0.html#gaa5d6b91c6ac72faf3a38044153f373d4">XOSD_CTL_OFFSET</a></div><div class="ttdeci">#define XOSD_CTL_OFFSET</div><div class="ttdoc">Control Offset. </div><div class="ttdef"><b>Definition:</b> xosd_hw.h:90</div></div>
<div class="ttc" id="group__osd__v4__0_html_ga68088d2cf45788126489895482f52276"><div class="ttname"><a href="group__osd__v4__0.html#ga68088d2cf45788126489895482f52276">XOSD_CTL_FSYNC_MASK</a></div><div class="ttdeci">#define XOSD_CTL_FSYNC_MASK</div><div class="ttdoc">Frame Sync Reset Mask. </div><div class="ttdef"><b>Definition:</b> xosd_hw.h:732</div></div>
</div><!-- fragment -->
<p>This function macro resets a OSD core at the end of the frame being processed. </p>
<p>It enables core automatically synchronizes to the SOF of the core to prevent image tearing. This function macro is differ from <a class="el" href="group__osd__v4__0.html#ga2ccc3d88129121707113a37dd1a7dea8" title="This function macro resets an OSD core This effects the core immediately, and may cause image tearing...">XOsd_Reset()</a>.</p>
<p>On the next rising-edge of SOF following a call to <a class="el" href="group__osd__v4__0.html#ga3a758a90dded736022ab70e7c0be8796" title="This function macro resets a OSD core at the end of the frame being processed. ">XOsd_SyncReset()</a>, all of the core's configuration registers and outputs will be reset, then the reset flag will be immediately released, allowing the core to immediately resume default operation.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_osd.html" title="The XOsd instance data. ">XOsd</a> instance to be worked on.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>C-style signature: void <a class="el" href="group__osd__v4__0.html#ga3a758a90dded736022ab70e7c0be8796" title="This function macro resets a OSD core at the end of the frame being processed. ">XOsd_SyncReset(XOsd *InstancePtr)</a> This bit automatically clears when reset complete. </dd></dl>

</div>
</div>
<a class="anchor" id="gaf4c0ce396e98531dc80b593b3b7557b2"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_VER_MAJOR_MASK&#160;&#160;&#160;0xFF000000</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Major Version Mask. </p>

</div>
</div>
<a class="anchor" id="ga079f481173bbb835dfc0f47b2c7d7af4"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_VER_MAJOR_SHIFT&#160;&#160;&#160;24</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Major Version Shift. </p>

</div>
</div>
<a class="anchor" id="gac1483a4d527969d76a659e645be3f617"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_VER_MINOR_MASK&#160;&#160;&#160;0x00FF0000</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Minor Version Mask. </p>

</div>
</div>
<a class="anchor" id="gaff3ce24678475480c9c6604613fdb214"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_VER_MINOR_SHIFT&#160;&#160;&#160;16</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Minor Version Bit Shift. </p>

</div>
</div>
<a class="anchor" id="ga36e95c1f63aa950517fb1f08a588ca01"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_VER_OFFSET&#160;&#160;&#160;0x010</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Version Offset. </p>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#ga94b9d7eac70a2fc2315b07059e832986">XOsd_GetVersion()</a>, and <a class="el" href="group__osd__v4__0.html#ga8a5fad0300d0413161f50c5df445a08f">XOsd_SelfTest()</a>.</p>

</div>
</div>
<a class="anchor" id="ga350bb744c50ec8d79e0e02d83fe0c35b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_VER_REV_MASK&#160;&#160;&#160;0x0000F000</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Revision Version Mask. </p>

</div>
</div>
<a class="anchor" id="gaf6a1c6f62f348c33f99c1e5acdafb6b1"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOSD_VER_REV_SHIFT&#160;&#160;&#160;12</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>Revision Bit Shift. </p>

</div>
</div>
<a class="anchor" id="ga37791d01d7ba72baa57bd45c2744a6b7"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XOsd_WriteReg</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">BaseAddress, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">RegOffset, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">Data&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td>&#160;&#160;&#160;XOsd_Out32((BaseAddress) + (u32)(RegOffset), (Data))</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>&gt;</code></p>

<p>This function writes the given register. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">BaseAddress</td><td>is the base address of the OSD core. </td></tr>
    <tr><td class="paramname">RegOffset</td><td>is the register offset of the OSD core. </td></tr>
    <tr><td class="paramname">Data</td><td>is the 32-bit value to write into the core register.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>C-style signature: void <a class="el" href="group__osd__v4__0.html#ga37791d01d7ba72baa57bd45c2744a6b7" title="This function writes the given register. ">XOsd_WriteReg(u32 BaseAddress, u32 RegOffset, u32 Data)</a> </dd></dl>

<p>Referenced by <a class="el" href="group__osd__v4__0.html#ga1ecd1900b797b12867274e0daf1a8d62">XOsd_DisableLayer()</a>, <a class="el" href="group__osd__v4__0.html#gacdb4b75859dbfc611d70382fb2c94a7f">XOsd_EnableLayer()</a>, <a class="el" href="group__osd__v4__0.html#ga6579cb01322e477e72faec9ea6feee63">XOsd_LoadCharacterSetBank()</a>, <a class="el" href="group__osd__v4__0.html#ga9d28c4453d039dc09b540d55c78c80b2">XOsd_LoadColorLUTBank()</a>, <a class="el" href="group__osd__v4__0.html#ga55937cb3259f5843c9e1beec4e126955">XOsd_LoadInstructionList()</a>, <a class="el" href="group__osd__v4__0.html#ga5a76210dc91d4a51111855bbc501c4e8">XOsd_LoadTextBank()</a>, <a class="el" href="group__osd__v4__0.html#ga5552532bfdfcd272722180e71d6c7b75">XOsd_SetActiveBank()</a>, <a class="el" href="group__osd__v4__0.html#ga037810c3a4ef79dba6cc202afc679373">XOsd_SetActiveSize()</a>, <a class="el" href="group__osd__v4__0.html#gab2040236e554455aa030814966dad413">XOsd_SetBackgroundColor()</a>, <a class="el" href="group__osd__v4__0.html#ga08b6809a1bd0d27dd275e06fe1cbea61">XOsd_SetLayerAlpha()</a>, <a class="el" href="group__osd__v4__0.html#ga33679ac417b6f2596c6b6b085d39a5b1">XOsd_SetLayerDimension()</a>, and <a class="el" href="group__osd__v4__0.html#gae10e5b163cf71fd385200b724d1dd560">XOsd_SetLayerPriority()</a>.</p>

</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="gab6e55293af64ef50112d468e2b327c93"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef void(* XOsd_CallBack) (void *CallBackRef)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd_8h.html">xosd.h</a>&gt;</code></p>

<p>This function callback type for all interrupts except error interrupt. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">CallBackRef</td><td>is a callback reference passed in by the upper layer when setting the callback functions and passed back to the upper layer when the callback is invoked.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

</div>
</div>
<a class="anchor" id="gae4470e2d494f46907e1b2602a5b04d0b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef void(* XOsd_ErrorCallBack) (void *CallBackRef, u32 ErrorMask)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd_8h.html">xosd.h</a>&gt;</code></p>

<p>This function callback type for error interrupt. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">CallBackRef</td><td>is a callback reference passed in by the upper layer when setting the callback functions, and passed back to the upper layer when the callback is invoked. </td></tr>
    <tr><td class="paramname">ErrorMask</td><td>is a bit mask indicating the cause of the error. Its value equals 'OR'ing one or more XOSD_IXR_* values defined in <a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

</div>
</div>
<a class="anchor" id="gad6799381b1f4b3353fa00f82da6b381f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef u32 XOsd_Instruction[<a class="el" href="group__osd__v4__0.html#gaf52a55e9ca22269266faf951be024ee1">XOSD_INS_SIZE</a>]</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd_8h.html">xosd.h</a>&gt;</code></p>

<p>The XOsd_Instruction data structure for holding one GC instruction. </p>

</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="ga06fc87d81c62e9abb8790b6e5713c55b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">anonymous enum</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd_8h.html">xosd.h</a>&gt;</code></p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="gga06fc87d81c62e9abb8790b6e5713c55ba41c52bbf34e031cfb024cb0b21e7a212"></a>XOSD_HANDLER_PROCSTART&#160;</td><td class="fielddoc">
<p>A processing start event interrupt type. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga06fc87d81c62e9abb8790b6e5713c55bac2aa1b96540765ad7b91aad694e3072b"></a>XOSD_HANDLER_FRAMEDONE&#160;</td><td class="fielddoc">
<p>A frame done event interrupt type. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga06fc87d81c62e9abb8790b6e5713c55bafe9b918732108caa970d83f22fceecfc"></a>XOSD_HANDLER_ERROR&#160;</td><td class="fielddoc">
<p>An error condition interrupt type. </p>
</td></tr>
</table>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="gaf9dad59565307cd8f71b385689f91048"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XOsd_CfgInitialize </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_osd.html">XOsd</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="struct_x_osd___config.html">XOsd_Config</a> *&#160;</td>
          <td class="paramname"><em>CfgPtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>EffectiveAddr</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd_8c.html">xosd.c</a>&gt;</code></p>

<p>This function initializes an OSD core. </p>
<p>This function must be called prior to using an OSD core. Initialization of an OSD includes setting up the instance data and ensuring the hardware is in a quiescent state.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_osd.html" title="The XOsd instance data. ">XOsd</a> instance to be worked on. </td></tr>
    <tr><td class="paramname">CfgPtr</td><td>points to the configuration structure associated with the OSD core. </td></tr>
    <tr><td class="paramname">EffectiveAddr</td><td>is the base address of the core. If address translation is being used, then this parameter must reflect the virtual base address. Otherwise, the physical address should be used.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>- XST_SUCCESS if XOsd_CfgInitialize was successful.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_osd___config.html#a0184842cb2ea8cc47ef55263d68d28e8">XOsd_Config::BaseAddress</a>, <a class="el" href="struct_x_osd.html#a75b2217e888eaab5cdc6b94015920bcf">XOsd::Config</a>, <a class="el" href="struct_x_osd.html#a11b8f2d180fd2d92b6c7629926e651fd">XOsd::ErrCallBack</a>, <a class="el" href="struct_x_osd.html#a2172512b6169dc40a5cd2c015f8e1554">XOsd::FrameDoneCallBack</a>, <a class="el" href="struct_x_osd.html#afc253b631db03783ef2965698eca860c">XOsd::InstructionInExternalMem</a>, <a class="el" href="struct_x_osd.html#a38a8bd573a3623c8d22a42c331007658">XOsd::IsReady</a>, <a class="el" href="struct_x_osd___config.html#a579e05fdc45e85e14db12c6c5db475f6">XOsd_Config::LayerNum</a>, <a class="el" href="struct_x_osd.html#ae55843d9b4871ac1061849f7fcb5d600">XOsd::ProcStartCallBack</a>, <a class="el" href="group__osd__v4__0.html#ga9bbf9f4ac7f8a29a4666da1eaa076089">XOSD_MAX_NUM_OF_LAYERS</a>, and <a class="el" href="group__osd__v4__0.html#ga2ccc3d88129121707113a37dd1a7dea8">XOsd_Reset</a>.</p>

</div>
</div>
<a class="anchor" id="ga7abff2415587a54c259f159fc780e2cc"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XOsd_CreateInstruction </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_osd.html">XOsd</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>InstructionPtr</em>[], </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8&#160;</td>
          <td class="paramname"><em>GcIndex</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>ObjType</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8&#160;</td>
          <td class="paramname"><em>ObjSize</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>XStart</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>YStart</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>XEnd</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>YEnd</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8&#160;</td>
          <td class="paramname"><em>TextIndex</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8&#160;</td>
          <td class="paramname"><em>ColorIndex</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd_8c.html">xosd.c</a>&gt;</code></p>

<p>This function creates an instruction for the OSD core. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_osd.html" title="The XOsd instance data. ">XOsd</a> instance to be worked on. </td></tr>
    <tr><td class="paramname">InstructionPtr</td><td>is a pointer to the instruction buffer to be populated with the instruction to be created. The upper level application is responsible for allocating this instruction buffer. </td></tr>
    <tr><td class="paramname">GcIndex</td><td>indicates the Graphics Controller that will consume the instruction. Valid value range is from 0 to (The Number of Layers) - 1. The layer's type must be set to XOSD_LAYER_TYPE_GPU (defined in <a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>) for this function to work properly. </td></tr>
    <tr><td class="paramname">ObjType</td><td>indicates the type of object to draw. Use one of XOSD_INS_OPCODE_* constants defined in <a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>. </td></tr>
    <tr><td class="paramname">ObjSize</td><td>indicates line width of boxes and lines and the text scale factor for text boxes. </td></tr>
    <tr><td class="paramname">XStart</td><td>indicates the horizontal start pixel of the Object. </td></tr>
    <tr><td class="paramname">YStart</td><td>indicates the vertical start line of the Object. </td></tr>
    <tr><td class="paramname">XEnd</td><td>indicates the horizontal end pixel of the Object. </td></tr>
    <tr><td class="paramname">YEnd</td><td>indicates the vertical end line of the Object. </td></tr>
    <tr><td class="paramname">TextIndex</td><td>indicates the string index. </td></tr>
    <tr><td class="paramname">ColorIndex</td><td>indicates the color index.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_osd.html#a38a8bd573a3623c8d22a42c331007658">XOsd::IsReady</a>, <a class="el" href="struct_x_osd.html#a4fed4f9d4d3240f0c24524fee0b04d9c">XOsd::Layers</a>, <a class="el" href="struct_x_osd___layer.html#a013b375fa16c618f303251141a01c887">XOsd_Layer::LayerType</a>, <a class="el" href="struct_x_osd___layer.html#a673926b13f628fc8da7f8257438fc1e4">XOsd_Layer::TextNumStrings</a>, <a class="el" href="group__osd__v4__0.html#ga2e8bfbd972e0ac9e0ba6f163f424a83e">XOSD_INS0</a>, <a class="el" href="group__osd__v4__0.html#ga0f5a79d13524e9f9cc1dd1bb1c6b4e17">XOSD_INS0_GCNUM_MASK</a>, <a class="el" href="group__osd__v4__0.html#gac3a8f3b2a9b5033e28b4d01816831069">XOSD_INS0_GCNUM_SHIFT</a>, <a class="el" href="group__osd__v4__0.html#gaee38041f6b3686d192becfdc9d625108">XOSD_INS0_OPCODE_MASK</a>, <a class="el" href="group__osd__v4__0.html#gaf95cc7852856ccf13f0d2b96fc17507d">XOSD_INS0_OPCODE_SHIFT</a>, <a class="el" href="group__osd__v4__0.html#ga316274c11c4bdf01881be2e5fa8c3ddd">XOSD_INS0_XEND_MASK</a>, <a class="el" href="group__osd__v4__0.html#ga0718123f4128faf36a3613d4d83d9bc9">XOSD_INS0_XEND_SHIFT</a>, <a class="el" href="group__osd__v4__0.html#gac28f5bcf9429cd6d5db7ba73dd8037e0">XOSD_INS0_XSTART_MASK</a>, <a class="el" href="group__osd__v4__0.html#ga85673ee70fcf9f62d30dbbe12f9ea4a6">XOSD_INS1</a>, <a class="el" href="group__osd__v4__0.html#ga845d109b3f71bafffbad75d0fc096e95">XOSD_INS1_TXTINDEX_MASK</a>, <a class="el" href="group__osd__v4__0.html#gab3b51f42fb458498b44640a4d7f48447">XOSD_INS2</a>, <a class="el" href="group__osd__v4__0.html#ga308b392a1c8f2e3b58c34b60f3c832e2">XOSD_INS2_OBJSIZE_MASK</a>, <a class="el" href="group__osd__v4__0.html#ga2e64473070f0ad81308d0fdde70c846e">XOSD_INS2_OBJSIZE_SHIFT</a>, <a class="el" href="group__osd__v4__0.html#gaf441c303e232e267cecd015457c3b059">XOSD_INS2_YEND_MASK</a>, <a class="el" href="group__osd__v4__0.html#ga557eb7583fc6e177b653144e1dd46309">XOSD_INS2_YEND_SHIFT</a>, <a class="el" href="group__osd__v4__0.html#ga572eaf61ee8df22c543f6cf017fd4b4d">XOSD_INS2_YSTART_MASK</a>, <a class="el" href="group__osd__v4__0.html#gaffb751247452fc737ba7f4c5a2a0a158">XOSD_INS3</a>, <a class="el" href="group__osd__v4__0.html#gabaf54e22c321fa30301173f7a7a8404c">XOSD_INS3_COL_MASK</a>, <a class="el" href="group__osd__v4__0.html#ga8c2bdbf05a06c913c482769abb207a04">XOSD_INS_OPCODE_BOX</a>, <a class="el" href="group__osd__v4__0.html#ga06d2e8c7a16846a74ffa8413261c1b42">XOSD_INS_OPCODE_BOXTXT</a>, <a class="el" href="group__osd__v4__0.html#ga020a93ee98e26b3e9bef6d37bdca6d93">XOSD_INS_OPCODE_END</a>, <a class="el" href="group__osd__v4__0.html#ga4d4d7f9062d81c4db38142348c23db3c">XOSD_INS_OPCODE_LINE</a>, <a class="el" href="group__osd__v4__0.html#gab378c3a2033c60420990fc0c6e035de8">XOSD_INS_OPCODE_NOP</a>, <a class="el" href="group__osd__v4__0.html#ga594d67ea3248e5eb9cc243f7436c0506">XOSD_INS_OPCODE_TXT</a>, <a class="el" href="group__osd__v4__0.html#gaf52a55e9ca22269266faf951be024ee1">XOSD_INS_SIZE</a>, and <a class="el" href="group__osd__v4__0.html#ga5b24c90cd1ba5772581eb7b743d2abe9">XOSD_LAYER_TYPE_GPU</a>.</p>

</div>
</div>
<a class="anchor" id="ga1ecd1900b797b12867274e0daf1a8d62"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XOsd_DisableLayer </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_osd.html">XOsd</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8&#160;</td>
          <td class="paramname"><em>LayerIndex</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd_8c.html">xosd.c</a>&gt;</code></p>

<p>This function disables an OSD layer. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_osd.html" title="The XOsd instance data. ">XOsd</a> instance to be worked on. </td></tr>
    <tr><td class="paramname">LayerIndex</td><td>indicates which layer to be worked on. Valid value range is from 0 to (the number of layers implemented in the core - 1).</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_osd___config.html#a0184842cb2ea8cc47ef55263d68d28e8">XOsd_Config::BaseAddress</a>, <a class="el" href="struct_x_osd.html#a75b2217e888eaab5cdc6b94015920bcf">XOsd::Config</a>, <a class="el" href="struct_x_osd.html#a38a8bd573a3623c8d22a42c331007658">XOsd::IsReady</a>, <a class="el" href="struct_x_osd.html#a4fed4f9d4d3240f0c24524fee0b04d9c">XOsd::Layers</a>, <a class="el" href="struct_x_osd___layer.html#a013b375fa16c618f303251141a01c887">XOsd_Layer::LayerType</a>, <a class="el" href="group__osd__v4__0.html#gab825adfb1951ceab0492b842f71aacca">XOSD_L0C_OFFSET</a>, <a class="el" href="group__osd__v4__0.html#ga59528981053fa8883db1b0b897ca0c06">XOSD_LAYER_SIZE</a>, <a class="el" href="group__osd__v4__0.html#gaaaab169a7980313aad002f2301cd8023">XOSD_LAYER_TYPE_DISABLE</a>, <a class="el" href="group__osd__v4__0.html#gaa7a4a31d3453e33f287b1be4ac4dd866">XOSD_LXC</a>, <a class="el" href="group__osd__v4__0.html#ga222fb398c40df639f9dfdb9ccdf67964">XOSD_LXC_EN_MASK</a>, <a class="el" href="group__osd__v4__0.html#ga09c0fe42f0cb0fe4a84e84acb6d548f3">XOsd_ReadReg</a>, and <a class="el" href="group__osd__v4__0.html#ga37791d01d7ba72baa57bd45c2744a6b7">XOsd_WriteReg</a>.</p>

</div>
</div>
<a class="anchor" id="gacdb4b75859dbfc611d70382fb2c94a7f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XOsd_EnableLayer </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_osd.html">XOsd</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8&#160;</td>
          <td class="paramname"><em>LayerIndex</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd_8c.html">xosd.c</a>&gt;</code></p>

<p>This function enables an OSD layer. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_osd.html" title="The XOsd instance data. ">XOsd</a> instance to be worked on. </td></tr>
    <tr><td class="paramname">LayerIndex</td><td>indicates which layer to be worked on. Valid value range is from 0 to (the number of layers implemented in the core - 1).</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_osd___config.html#a0184842cb2ea8cc47ef55263d68d28e8">XOsd_Config::BaseAddress</a>, <a class="el" href="struct_x_osd.html#a75b2217e888eaab5cdc6b94015920bcf">XOsd::Config</a>, <a class="el" href="struct_x_osd.html#a38a8bd573a3623c8d22a42c331007658">XOsd::IsReady</a>, <a class="el" href="struct_x_osd.html#a4fed4f9d4d3240f0c24524fee0b04d9c">XOsd::Layers</a>, <a class="el" href="struct_x_osd___layer.html#a013b375fa16c618f303251141a01c887">XOsd_Layer::LayerType</a>, <a class="el" href="group__osd__v4__0.html#gab825adfb1951ceab0492b842f71aacca">XOSD_L0C_OFFSET</a>, <a class="el" href="group__osd__v4__0.html#ga59528981053fa8883db1b0b897ca0c06">XOSD_LAYER_SIZE</a>, <a class="el" href="group__osd__v4__0.html#gaaaab169a7980313aad002f2301cd8023">XOSD_LAYER_TYPE_DISABLE</a>, <a class="el" href="group__osd__v4__0.html#gaa7a4a31d3453e33f287b1be4ac4dd866">XOSD_LXC</a>, <a class="el" href="group__osd__v4__0.html#ga222fb398c40df639f9dfdb9ccdf67964">XOSD_LXC_EN_MASK</a>, <a class="el" href="group__osd__v4__0.html#ga09c0fe42f0cb0fe4a84e84acb6d548f3">XOsd_ReadReg</a>, and <a class="el" href="group__osd__v4__0.html#ga37791d01d7ba72baa57bd45c2744a6b7">XOsd_WriteReg</a>.</p>

</div>
</div>
<a class="anchor" id="gafad06669f4df698b225bfe8b05e6dbbd"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XOsd_GetActiveSize </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_osd.html">XOsd</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32 *&#160;</td>
          <td class="paramname"><em>WidthPtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32 *&#160;</td>
          <td class="paramname"><em>HeightPtr</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd_8c.html">xosd.c</a>&gt;</code></p>

<p>This function gets the screen size of the OSD Output. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_osd.html" title="The XOsd instance data. ">XOsd</a> instance to be worked on. </td></tr>
    <tr><td class="paramname">WidthPtr</td><td>will point to the width of the OSD output after this function returns. </td></tr>
    <tr><td class="paramname">HeightPtr</td><td>will point to the height of the OSD output after this function returns.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_osd___config.html#a0184842cb2ea8cc47ef55263d68d28e8">XOsd_Config::BaseAddress</a>, <a class="el" href="struct_x_osd.html#a75b2217e888eaab5cdc6b94015920bcf">XOsd::Config</a>, <a class="el" href="struct_x_osd.html#a38a8bd573a3623c8d22a42c331007658">XOsd::IsReady</a>, <a class="el" href="group__osd__v4__0.html#gade3687044261450fc11f800ce9414a02">XOSD_ACTIVE_SIZE_OFFSET</a>, <a class="el" href="group__osd__v4__0.html#gac75b658316a6744fba822b9d19cdbd96">XOSD_ACTSIZE_NUM_LINE_MASK</a>, <a class="el" href="group__osd__v4__0.html#ga9ac4754b89e00ebaa197523d94c5abab">XOSD_ACTSIZE_NUM_LINE_SHIFT</a>, <a class="el" href="group__osd__v4__0.html#gaee78e03170b5d597abcdb41bb789987a">XOSD_ACTSIZE_NUM_PIXEL_MASK</a>, and <a class="el" href="group__osd__v4__0.html#ga09c0fe42f0cb0fe4a84e84acb6d548f3">XOsd_ReadReg</a>.</p>

</div>
</div>
<a class="anchor" id="gaa7361c792b36dafe0e48ae22c32cf125"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XOsd_GetBackgroundColor </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_osd.html">XOsd</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16 *&#160;</td>
          <td class="paramname"><em>RedPtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16 *&#160;</td>
          <td class="paramname"><em>BluePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16 *&#160;</td>
          <td class="paramname"><em>GreenPtr</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd_8c.html">xosd.c</a>&gt;</code></p>

<p>This function gets the background color used by the OSD output. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_osd.html" title="The XOsd instance data. ">XOsd</a> instance to be worked on. </td></tr>
    <tr><td class="paramname">RedPtr</td><td>will point to the red value used in the background color after this function returns. </td></tr>
    <tr><td class="paramname">BluePtr</td><td>will point to the blue value used in the background color after this function returns. </td></tr>
    <tr><td class="paramname">GreenPtr</td><td>will point to the green value used in the background color after this function returns.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_osd___config.html#a0184842cb2ea8cc47ef55263d68d28e8">XOsd_Config::BaseAddress</a>, <a class="el" href="struct_x_osd.html#a75b2217e888eaab5cdc6b94015920bcf">XOsd::Config</a>, <a class="el" href="struct_x_osd.html#a38a8bd573a3623c8d22a42c331007658">XOsd::IsReady</a>, <a class="el" href="group__osd__v4__0.html#ga05c21ad0e43e61c2a4a904d60ff59a0f">XOSD_BC0_OFFSET</a>, <a class="el" href="group__osd__v4__0.html#ga636eaade937285fa383032f1013e4007">XOSD_BC0_YG_MASK</a>, <a class="el" href="group__osd__v4__0.html#gaf595fa566ff6e43a0b68207b87ae934b">XOSD_BC1_OFFSET</a>, <a class="el" href="group__osd__v4__0.html#gadbc74a40e404c4500625c304f6038eb8">XOSD_BC1_UCBB_MASK</a>, <a class="el" href="group__osd__v4__0.html#ga9196d5680140ee807654c6cfc14f8319">XOSD_BC2_OFFSET</a>, <a class="el" href="group__osd__v4__0.html#ga5ea983e4b594d372821939b55c4f1ec3">XOSD_BC2_VCRR_MASK</a>, and <a class="el" href="group__osd__v4__0.html#ga09c0fe42f0cb0fe4a84e84acb6d548f3">XOsd_ReadReg</a>.</p>

</div>
</div>
<a class="anchor" id="gab692eaddc144c270dfb05f7171c403e2"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XOsd_GetLayerAlpha </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_osd.html">XOsd</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8&#160;</td>
          <td class="paramname"><em>LayerIndex</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16 *&#160;</td>
          <td class="paramname"><em>GlobalAlphaEnablePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16 *&#160;</td>
          <td class="paramname"><em>GlobalAlphaValuePtr</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd_8c.html">xosd.c</a>&gt;</code></p>

<p>This function gets the alpha value and mode of an OSD layer. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_osd.html" title="The XOsd instance data. ">XOsd</a> instance to be worked on. </td></tr>
    <tr><td class="paramname">LayerIndex</td><td>indicates which layer to be worked on. Valid value range is from 0 to (the number of layers implemented in the core - 1). </td></tr>
    <tr><td class="paramname">GlobalAlphaEnablePtr</td><td>will point to a flag indicating whether the global alpha is enabled on a layer after this function returns. Flag 1 indicates that the global alpha is enabled, 0 indicates that it is not. </td></tr>
    <tr><td class="paramname">GlobalAlphaValuePtr</td><td>will point to the transparent level after this function returns. 0 for 100% transparent, 255 (8bit) for 0% transparent (100% opaque).</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_osd___config.html#a0184842cb2ea8cc47ef55263d68d28e8">XOsd_Config::BaseAddress</a>, <a class="el" href="struct_x_osd.html#a75b2217e888eaab5cdc6b94015920bcf">XOsd::Config</a>, <a class="el" href="struct_x_osd.html#a38a8bd573a3623c8d22a42c331007658">XOsd::IsReady</a>, <a class="el" href="struct_x_osd.html#a4fed4f9d4d3240f0c24524fee0b04d9c">XOsd::Layers</a>, <a class="el" href="struct_x_osd___layer.html#a013b375fa16c618f303251141a01c887">XOsd_Layer::LayerType</a>, <a class="el" href="group__osd__v4__0.html#gab825adfb1951ceab0492b842f71aacca">XOSD_L0C_OFFSET</a>, <a class="el" href="group__osd__v4__0.html#ga59528981053fa8883db1b0b897ca0c06">XOSD_LAYER_SIZE</a>, <a class="el" href="group__osd__v4__0.html#gaaaab169a7980313aad002f2301cd8023">XOSD_LAYER_TYPE_DISABLE</a>, <a class="el" href="group__osd__v4__0.html#gaa7a4a31d3453e33f287b1be4ac4dd866">XOSD_LXC</a>, <a class="el" href="group__osd__v4__0.html#gad95aafec82b865159f52e65949c23529">XOSD_LXC_ALPHA_MASK</a>, <a class="el" href="group__osd__v4__0.html#ga8b9042e82d8df689be0036e9ede471f2">XOSD_LXC_ALPHA_SHIFT</a>, <a class="el" href="group__osd__v4__0.html#gabe784eba2fa547d6a70591efa719dd16">XOSD_LXC_GALPHAEN_MASK</a>, and <a class="el" href="group__osd__v4__0.html#ga09c0fe42f0cb0fe4a84e84acb6d548f3">XOsd_ReadReg</a>.</p>

</div>
</div>
<a class="anchor" id="ga3223d1726b2e25cda7de089d85353c1b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XOsd_GetLayerDimension </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_osd.html">XOsd</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8&#160;</td>
          <td class="paramname"><em>LayerIndex</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16 *&#160;</td>
          <td class="paramname"><em>XStartPtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16 *&#160;</td>
          <td class="paramname"><em>YStartPtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16 *&#160;</td>
          <td class="paramname"><em>XSizePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16 *&#160;</td>
          <td class="paramname"><em>YSizePtr</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd_8c.html">xosd.c</a>&gt;</code></p>

<p>This function gets the start position and size of an OSD layer. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_osd.html" title="The XOsd instance data. ">XOsd</a> instance to be worked on. </td></tr>
    <tr><td class="paramname">LayerIndex</td><td>indicates which layer to be worked on. Valid value range is from 0 to (the number of layers implemented in the core - 1). </td></tr>
    <tr><td class="paramname">XStartPtr</td><td>will point to the horizontal start pixel value of origin of the layer after this function returns. </td></tr>
    <tr><td class="paramname">YStartPtr</td><td>will point to the vertical start line of origin of the layer after this function returns. </td></tr>
    <tr><td class="paramname">XSizePtr</td><td>will point to the horizontal size value of the layer after this function returns. </td></tr>
    <tr><td class="paramname">YSizePtr</td><td>will point to the vertical size value of the layer after this function returns.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_osd___config.html#a0184842cb2ea8cc47ef55263d68d28e8">XOsd_Config::BaseAddress</a>, <a class="el" href="struct_x_osd.html#a75b2217e888eaab5cdc6b94015920bcf">XOsd::Config</a>, <a class="el" href="struct_x_osd.html#a38a8bd573a3623c8d22a42c331007658">XOsd::IsReady</a>, <a class="el" href="struct_x_osd.html#a4fed4f9d4d3240f0c24524fee0b04d9c">XOsd::Layers</a>, <a class="el" href="struct_x_osd___layer.html#a013b375fa16c618f303251141a01c887">XOsd_Layer::LayerType</a>, <a class="el" href="group__osd__v4__0.html#gab825adfb1951ceab0492b842f71aacca">XOSD_L0C_OFFSET</a>, <a class="el" href="group__osd__v4__0.html#ga59528981053fa8883db1b0b897ca0c06">XOSD_LAYER_SIZE</a>, <a class="el" href="group__osd__v4__0.html#gaaaab169a7980313aad002f2301cd8023">XOSD_LAYER_TYPE_DISABLE</a>, <a class="el" href="group__osd__v4__0.html#ga06bbfe6e69f2747df8d5260827f588fa">XOSD_LXP</a>, <a class="el" href="group__osd__v4__0.html#ga54711c94080d9bc076195b0747729856">XOSD_LXP_XSTART_MASK</a>, <a class="el" href="group__osd__v4__0.html#ga7c23d1cec7d28b5ac5c8632fe602bf9c">XOSD_LXP_YSTART_MASK</a>, <a class="el" href="group__osd__v4__0.html#gac828bb35053a7d8f8ecfc27766ec6703">XOSD_LXP_YSTART_SHIFT</a>, <a class="el" href="group__osd__v4__0.html#ga1679b9fa0d6170817f443a7c24c10a62">XOSD_LXS</a>, <a class="el" href="group__osd__v4__0.html#ga0ce8e4abc1669f61786c556bb496a471">XOSD_LXS_XSIZE_MASK</a>, <a class="el" href="group__osd__v4__0.html#ga1a19bab0f8bae1dbbfe591ad6338757a">XOSD_LXS_YSIZE_MASK</a>, <a class="el" href="group__osd__v4__0.html#ga3b683ef20fa0d1f9d9dfca72fe9bed28">XOSD_LXS_YSIZE_SHIFT</a>, and <a class="el" href="group__osd__v4__0.html#ga09c0fe42f0cb0fe4a84e84acb6d548f3">XOsd_ReadReg</a>.</p>

</div>
</div>
<a class="anchor" id="ga02cbaaa4f5e6b640c876b727db267602"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XOsd_GetLayerPriority </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_osd.html">XOsd</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8&#160;</td>
          <td class="paramname"><em>LayerIndex</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8 *&#160;</td>
          <td class="paramname"><em>PriorityPtr</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd_8c.html">xosd.c</a>&gt;</code></p>

<p>This function gets the priority of an OSD layer. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_osd.html" title="The XOsd instance data. ">XOsd</a> instance to be worked on. </td></tr>
    <tr><td class="paramname">LayerIndex</td><td>indicates which layer to be worked on. Valid value range is from 0 to (the number of layers implemented in the core - 1). </td></tr>
    <tr><td class="paramname">PriorityPtr</td><td>will point to the priority used on the layer after this function returns. Use one of XOSD_LAYER_PRIORITY_0 (the lowest priority) through XOSD_LAYER_PRIORITY_7 (the highest priority) defined in <a class="el" href="xosd__hw_8h.html">xosd_hw.h</a> to interpret the value.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_osd___config.html#a0184842cb2ea8cc47ef55263d68d28e8">XOsd_Config::BaseAddress</a>, <a class="el" href="struct_x_osd.html#a75b2217e888eaab5cdc6b94015920bcf">XOsd::Config</a>, <a class="el" href="struct_x_osd.html#a38a8bd573a3623c8d22a42c331007658">XOsd::IsReady</a>, <a class="el" href="struct_x_osd.html#a4fed4f9d4d3240f0c24524fee0b04d9c">XOsd::Layers</a>, <a class="el" href="struct_x_osd___layer.html#a013b375fa16c618f303251141a01c887">XOsd_Layer::LayerType</a>, <a class="el" href="group__osd__v4__0.html#gab825adfb1951ceab0492b842f71aacca">XOSD_L0C_OFFSET</a>, <a class="el" href="group__osd__v4__0.html#ga59528981053fa8883db1b0b897ca0c06">XOSD_LAYER_SIZE</a>, <a class="el" href="group__osd__v4__0.html#gaaaab169a7980313aad002f2301cd8023">XOSD_LAYER_TYPE_DISABLE</a>, <a class="el" href="group__osd__v4__0.html#gaa7a4a31d3453e33f287b1be4ac4dd866">XOSD_LXC</a>, <a class="el" href="group__osd__v4__0.html#gae1e09e803eb566221f3ad1ea9544534a">XOSD_LXC_PRIORITY_MASK</a>, <a class="el" href="group__osd__v4__0.html#ga2d7d038fb2a5bdf668dc3e39961e7644">XOSD_LXC_PRIORITY_SHIFT</a>, and <a class="el" href="group__osd__v4__0.html#ga09c0fe42f0cb0fe4a84e84acb6d548f3">XOsd_ReadReg</a>.</p>

</div>
</div>
<a class="anchor" id="ga94b9d7eac70a2fc2315b07059e832986"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XOsd_GetVersion </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_osd.html">XOsd</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd_8c.html">xosd.c</a>&gt;</code></p>

<p>This function returns the Version of the OSD core. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_osd.html" title="The XOsd instance data. ">XOsd</a> instance to be worked on.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Contents of the Version register.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_osd___config.html#a0184842cb2ea8cc47ef55263d68d28e8">XOsd_Config::BaseAddress</a>, <a class="el" href="struct_x_osd.html#a75b2217e888eaab5cdc6b94015920bcf">XOsd::Config</a>, <a class="el" href="group__osd__v4__0.html#ga09c0fe42f0cb0fe4a84e84acb6d548f3">XOsd_ReadReg</a>, and <a class="el" href="group__osd__v4__0.html#ga36e95c1f63aa950517fb1f08a588ca01">XOSD_VER_OFFSET</a>.</p>

</div>
</div>
<a class="anchor" id="ga7079d6f5586ca603657dac6b9e188105"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XOsd_IntrHandler </td>
          <td>(</td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd_8h.html">xosd.h</a>&gt;</code></p>

<p>This function is the interrupt handler for the On-Screen-Display driver. </p>
<p>This handler reads the pending interrupt from the IER/ISR, determines the source of the interrupts, calls according callbacks, and finally clears the interrupts.</p>
<p>The application is responsible for connecting this function to the interrupt system. Application beyond this driver is also responsible for providing callbacks to handle interrupts and installing the callbacks using <a class="el" href="group__osd__v4__0.html#ga3d389873d919422ef5f5d56592659481" title="This routine installs an asynchronous callback function for the given HandlerType: ...">XOsd_SetCallBack()</a> during initialization phase.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_osd.html" title="The XOsd instance data. ">XOsd</a> instance that just interrupted.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_osd.html#a11b8f2d180fd2d92b6c7629926e651fd">XOsd::ErrCallBack</a>, <a class="el" href="struct_x_osd.html#ac3de9ffdd6fe3b4e30f91f1d3f3637a6">XOsd::ErrRef</a>, <a class="el" href="struct_x_osd.html#a2172512b6169dc40a5cd2c015f8e1554">XOsd::FrameDoneCallBack</a>, <a class="el" href="struct_x_osd.html#a72e3b090dd5dfc03ec61e95d347b81b8">XOsd::FrameDoneRef</a>, <a class="el" href="struct_x_osd.html#a38a8bd573a3623c8d22a42c331007658">XOsd::IsReady</a>, <a class="el" href="struct_x_osd.html#ae55843d9b4871ac1061849f7fcb5d600">XOsd::ProcStartCallBack</a>, <a class="el" href="struct_x_osd.html#abc97cc4c250059d23a8375f539a7718d">XOsd::ProcStartRef</a>, <a class="el" href="group__osd__v4__0.html#ga2507152f445947e19e16ac59939adc9e">XOsd_IntrClear</a>, <a class="el" href="group__osd__v4__0.html#ga89fd83e071e7da016c89f9e155f1453a">XOsd_IntrGetPending</a>, <a class="el" href="group__osd__v4__0.html#gaa0d5d1c04e53cea07f1f53e36485ca5e">XOSD_IXR_ALLERR_MASK</a>, <a class="el" href="group__osd__v4__0.html#ga0411b83937245d123c394afb37aa17f3">XOSD_IXR_EOF_MASK</a>, and <a class="el" href="group__osd__v4__0.html#gad2803dca6d21253c1cb2b5920b3f8eac">XOSD_IXR_PROC_STARTED_MASK</a>.</p>

</div>
</div>
<a class="anchor" id="ga6579cb01322e477e72faec9ea6feee63"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XOsd_LoadCharacterSetBank </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_osd.html">XOsd</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8&#160;</td>
          <td class="paramname"><em>GcIndex</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8&#160;</td>
          <td class="paramname"><em>BankIndex</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>CharSetData</em>[]&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd_8c.html">xosd.c</a>&gt;</code></p>

<p>This function loads character set data (font) into an OSD Graphics Controller bank. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_osd.html" title="The XOsd instance data. ">XOsd</a> instance to be worked on. </td></tr>
    <tr><td class="paramname">GcIndex</td><td>indicates which Graphics Controller to work on. Valid value range is from 0 to (The Number of Layers) - 1. The layer's type must be set to XOSD_LAYER_TYPE_GPU (defined in <a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>) for this function to work properly. </td></tr>
    <tr><td class="paramname">BankIndex</td><td>indicates which GC bank to be worked on. Valid value range is from 0 to XOSD_GC_BANK_NUM - 1. </td></tr>
    <tr><td class="paramname">CharSetData</td><td>points to the character set data to be loaded.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_osd___config.html#a0184842cb2ea8cc47ef55263d68d28e8">XOsd_Config::BaseAddress</a>, <a class="el" href="struct_x_osd.html#a75b2217e888eaab5cdc6b94015920bcf">XOsd::Config</a>, <a class="el" href="struct_x_osd___layer.html#a8276913064bdaf98615e150f5ef8c454">XOsd_Layer::FontBitsPerPixel</a>, <a class="el" href="struct_x_osd___layer.html#ab219b64e7250bc2175092c7e820e210f">XOsd_Layer::FontHeight</a>, <a class="el" href="struct_x_osd___layer.html#a1b4c3636c712f5329df178ec3fac5310">XOsd_Layer::FontNumChars</a>, <a class="el" href="struct_x_osd___layer.html#a9b121c88331ebb25e0a2abb1e6e0228a">XOsd_Layer::FontWidth</a>, <a class="el" href="struct_x_osd.html#a38a8bd573a3623c8d22a42c331007658">XOsd::IsReady</a>, <a class="el" href="struct_x_osd.html#a4fed4f9d4d3240f0c24524fee0b04d9c">XOsd::Layers</a>, <a class="el" href="struct_x_osd___layer.html#a013b375fa16c618f303251141a01c887">XOsd_Layer::LayerType</a>, <a class="el" href="group__osd__v4__0.html#gaabff64a3ad88851d9c886d6bf91f6942">XOSD_FONT_BIT_TO_BYTE</a>, <a class="el" href="group__osd__v4__0.html#ga45ae5aa9dfc53098d0b710623fad8872">XOSD_GC_BANK_NUM</a>, <a class="el" href="group__osd__v4__0.html#ga3ef9c844a0695a6af31f5aba5254ebdb">XOSD_GCABA_CHR_SHIFT</a>, <a class="el" href="group__osd__v4__0.html#gaf8a5cab153ddb20712278001ab8bf534">XOSD_GCABA_OFFSET</a>, <a class="el" href="group__osd__v4__0.html#ga09280c9581cb52b21792d38917a29ba2">XOSD_GCD_OFFSET</a>, <a class="el" href="group__osd__v4__0.html#ga744f4c46706bb0fb5b0d3de3c5826c7f">XOSD_GCWBA_BANK_MASK</a>, <a class="el" href="group__osd__v4__0.html#ga4aeaabbe94c0e21210ed6ab657844ef3">XOSD_GCWBA_CHR0</a>, <a class="el" href="group__osd__v4__0.html#ga9b1814d86e5233adee245c745fa4930e">XOSD_GCWBA_GCNUM_MASK</a>, <a class="el" href="group__osd__v4__0.html#gaa649271aac06a31917c73c8a98728bee">XOSD_GCWBA_GCNUM_SHIFT</a>, <a class="el" href="group__osd__v4__0.html#gaad8f1c87d9bbbfda000f872824e8300a">XOSD_GCWBA_OFFSET</a>, <a class="el" href="group__osd__v4__0.html#ga5b24c90cd1ba5772581eb7b743d2abe9">XOSD_LAYER_TYPE_GPU</a>, <a class="el" href="group__osd__v4__0.html#ga09c0fe42f0cb0fe4a84e84acb6d548f3">XOsd_ReadReg</a>, and <a class="el" href="group__osd__v4__0.html#ga37791d01d7ba72baa57bd45c2744a6b7">XOsd_WriteReg</a>.</p>

</div>
</div>
<a class="anchor" id="ga9d28c4453d039dc09b540d55c78c80b2"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XOsd_LoadColorLUTBank </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_osd.html">XOsd</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8&#160;</td>
          <td class="paramname"><em>GcIndex</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8&#160;</td>
          <td class="paramname"><em>BankIndex</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>ColorData</em>[]&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd_8c.html">xosd.c</a>&gt;</code></p>

<p>This function loads color look up table data into an OSD Graphics Controller bank. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_osd.html" title="The XOsd instance data. ">XOsd</a> instance to be worked on. </td></tr>
    <tr><td class="paramname">GcIndex</td><td>indicates which Graphics Controller to work on. Valid value range is from 0 to (The Number of Layers) - 1. The layer's type must be set to XOSD_LAYER_TYPE_GPU (defined in <a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>) for this function to work properly. </td></tr>
    <tr><td class="paramname">BankIndex</td><td>indicates which GC Bank to be worked on. Valid value range is from 0 to XOSD_GC_BANK_NUM - 1. </td></tr>
    <tr><td class="paramname">ColorData</td><td>points to the color LUT data to be loaded.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_osd___config.html#a0184842cb2ea8cc47ef55263d68d28e8">XOsd_Config::BaseAddress</a>, <a class="el" href="struct_x_osd___layer.html#aad2001b2be1dbe72d429197244fd1540">XOsd_Layer::ColorLutSize</a>, <a class="el" href="struct_x_osd.html#a75b2217e888eaab5cdc6b94015920bcf">XOsd::Config</a>, <a class="el" href="struct_x_osd.html#a38a8bd573a3623c8d22a42c331007658">XOsd::IsReady</a>, <a class="el" href="struct_x_osd.html#a4fed4f9d4d3240f0c24524fee0b04d9c">XOsd::Layers</a>, <a class="el" href="struct_x_osd___layer.html#a013b375fa16c618f303251141a01c887">XOsd_Layer::LayerType</a>, <a class="el" href="struct_x_osd___config.html#a47c9598ee08d3d1710ad43614b23d676">XOsd_Config::SlaveAxisVideoDataWidth</a>, <a class="el" href="group__osd__v4__0.html#ga02df75e48788b9182ef56cfa94cccdd4">XOSD_COLOR_ENTRY_SIZE</a>, <a class="el" href="group__osd__v4__0.html#ga45ae5aa9dfc53098d0b710623fad8872">XOSD_GC_BANK_NUM</a>, <a class="el" href="group__osd__v4__0.html#ga0180a6f642268480d81a2a006ce8b85a">XOSD_GCABA_COL_SHIFT</a>, <a class="el" href="group__osd__v4__0.html#gaf8a5cab153ddb20712278001ab8bf534">XOSD_GCABA_OFFSET</a>, <a class="el" href="group__osd__v4__0.html#ga09280c9581cb52b21792d38917a29ba2">XOSD_GCD_OFFSET</a>, <a class="el" href="group__osd__v4__0.html#ga744f4c46706bb0fb5b0d3de3c5826c7f">XOSD_GCWBA_BANK_MASK</a>, <a class="el" href="group__osd__v4__0.html#gaaffb3c9e8b2db21168a8fb96a4566fea">XOSD_GCWBA_COL0</a>, <a class="el" href="group__osd__v4__0.html#ga9b1814d86e5233adee245c745fa4930e">XOSD_GCWBA_GCNUM_MASK</a>, <a class="el" href="group__osd__v4__0.html#gaa649271aac06a31917c73c8a98728bee">XOSD_GCWBA_GCNUM_SHIFT</a>, <a class="el" href="group__osd__v4__0.html#gaad8f1c87d9bbbfda000f872824e8300a">XOSD_GCWBA_OFFSET</a>, <a class="el" href="group__osd__v4__0.html#ga5b24c90cd1ba5772581eb7b743d2abe9">XOSD_LAYER_TYPE_GPU</a>, <a class="el" href="group__osd__v4__0.html#ga09c0fe42f0cb0fe4a84e84acb6d548f3">XOsd_ReadReg</a>, and <a class="el" href="group__osd__v4__0.html#ga37791d01d7ba72baa57bd45c2744a6b7">XOsd_WriteReg</a>.</p>

</div>
</div>
<a class="anchor" id="ga55937cb3259f5843c9e1beec4e126955"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XOsd_LoadInstructionList </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_osd.html">XOsd</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8&#160;</td>
          <td class="paramname"><em>GcIndex</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8&#160;</td>
          <td class="paramname"><em>BankIndex</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>InstSetPtr</em>[], </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>InstNum</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd_8c.html">xosd.c</a>&gt;</code></p>

<p>This function load an instruction list to be used by an Graphic Controller in the OSD core. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_osd.html" title="The XOsd instance data. ">XOsd</a> instance to be worked on. </td></tr>
    <tr><td class="paramname">GcIndex</td><td>indicates which Graphics Controller to work on. Valid value range is from 0 to (The Number of Layers) - 1. The layer's type must be set to XOSD_LAYER_TYPE_GPU (defined in <a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>) for this function to work properly. </td></tr>
    <tr><td class="paramname">BankIndex</td><td>indicates which GC Bank to be worked on. Valid value range is from 0 to XOSD_GC_BANK_NUM. </td></tr>
    <tr><td class="paramname">InstSetPtr</td><td>is a pointer to the start of the instruction list to load into the OSD core. The last instruction in the list must has XOSD_INS_OPCODE_END type. </td></tr>
    <tr><td class="paramname">InstNum</td><td>indicates the number of the instructions in the list to load. Valid value range is from 1 to the half of the size of the instruction memory created for the Graphic Controller.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_osd___config.html#a0184842cb2ea8cc47ef55263d68d28e8">XOsd_Config::BaseAddress</a>, <a class="el" href="struct_x_osd.html#a75b2217e888eaab5cdc6b94015920bcf">XOsd::Config</a>, <a class="el" href="struct_x_osd.html#a38a8bd573a3623c8d22a42c331007658">XOsd::IsReady</a>, <a class="el" href="struct_x_osd.html#a4fed4f9d4d3240f0c24524fee0b04d9c">XOsd::Layers</a>, <a class="el" href="struct_x_osd___layer.html#a013b375fa16c618f303251141a01c887">XOsd_Layer::LayerType</a>, <a class="el" href="group__osd__v4__0.html#ga45ae5aa9dfc53098d0b710623fad8872">XOSD_GC_BANK_NUM</a>, <a class="el" href="group__osd__v4__0.html#gaf8a5cab153ddb20712278001ab8bf534">XOSD_GCABA_OFFSET</a>, <a class="el" href="group__osd__v4__0.html#ga09280c9581cb52b21792d38917a29ba2">XOSD_GCD_OFFSET</a>, <a class="el" href="group__osd__v4__0.html#ga744f4c46706bb0fb5b0d3de3c5826c7f">XOSD_GCWBA_BANK_MASK</a>, <a class="el" href="group__osd__v4__0.html#ga9b1814d86e5233adee245c745fa4930e">XOSD_GCWBA_GCNUM_MASK</a>, <a class="el" href="group__osd__v4__0.html#gaa649271aac06a31917c73c8a98728bee">XOSD_GCWBA_GCNUM_SHIFT</a>, <a class="el" href="group__osd__v4__0.html#ga964674dbcc6e06590d99a20430cab2d6">XOSD_GCWBA_INS0</a>, <a class="el" href="group__osd__v4__0.html#gaad8f1c87d9bbbfda000f872824e8300a">XOSD_GCWBA_OFFSET</a>, <a class="el" href="group__osd__v4__0.html#gaf52a55e9ca22269266faf951be024ee1">XOSD_INS_SIZE</a>, <a class="el" href="group__osd__v4__0.html#ga5b24c90cd1ba5772581eb7b743d2abe9">XOSD_LAYER_TYPE_GPU</a>, <a class="el" href="group__osd__v4__0.html#ga09c0fe42f0cb0fe4a84e84acb6d548f3">XOsd_ReadReg</a>, and <a class="el" href="group__osd__v4__0.html#ga37791d01d7ba72baa57bd45c2744a6b7">XOsd_WriteReg</a>.</p>

</div>
</div>
<a class="anchor" id="ga5a76210dc91d4a51111855bbc501c4e8"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XOsd_LoadTextBank </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_osd.html">XOsd</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8&#160;</td>
          <td class="paramname"><em>GcIndex</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8&#160;</td>
          <td class="paramname"><em>BankIndex</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>TextData</em>[]&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd_8c.html">xosd.c</a>&gt;</code></p>

<p>This function loads text data into an OSD Graphics Controller bank. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_osd.html" title="The XOsd instance data. ">XOsd</a> instance to be worked on. </td></tr>
    <tr><td class="paramname">GcIndex</td><td>indicates which Graphics Controller to work on. Valid value range is from 0 to (The Number of Layers) - 1. The layer's type must be set to XOSD_LAYER_TYPE_GPU (defined in <a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>) for this function to work properly. </td></tr>
    <tr><td class="paramname">BankIndex</td><td>indicates which GC bank to be worked on. Valid value range is from 0 to XOSD_GC_BANK_NUM - 1. </td></tr>
    <tr><td class="paramname">TextData</td><td>points to the text data to be loaded.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_osd___config.html#a0184842cb2ea8cc47ef55263d68d28e8">XOsd_Config::BaseAddress</a>, <a class="el" href="struct_x_osd.html#a75b2217e888eaab5cdc6b94015920bcf">XOsd::Config</a>, <a class="el" href="struct_x_osd.html#a38a8bd573a3623c8d22a42c331007658">XOsd::IsReady</a>, <a class="el" href="struct_x_osd.html#a4fed4f9d4d3240f0c24524fee0b04d9c">XOsd::Layers</a>, <a class="el" href="struct_x_osd___layer.html#a013b375fa16c618f303251141a01c887">XOsd_Layer::LayerType</a>, <a class="el" href="struct_x_osd___layer.html#a00db4c777b648f8ec99e6868e3131422">XOsd_Layer::TextMaxStringLength</a>, <a class="el" href="group__osd__v4__0.html#ga45ae5aa9dfc53098d0b710623fad8872">XOSD_GC_BANK_NUM</a>, <a class="el" href="group__osd__v4__0.html#gaf8a5cab153ddb20712278001ab8bf534">XOSD_GCABA_OFFSET</a>, <a class="el" href="group__osd__v4__0.html#gaf4d8ce31dbe126d0fa8f5976c80de11d">XOSD_GCABA_TXT_SHIFT</a>, <a class="el" href="group__osd__v4__0.html#ga09280c9581cb52b21792d38917a29ba2">XOSD_GCD_OFFSET</a>, <a class="el" href="group__osd__v4__0.html#ga744f4c46706bb0fb5b0d3de3c5826c7f">XOSD_GCWBA_BANK_MASK</a>, <a class="el" href="group__osd__v4__0.html#ga9b1814d86e5233adee245c745fa4930e">XOSD_GCWBA_GCNUM_MASK</a>, <a class="el" href="group__osd__v4__0.html#gaa649271aac06a31917c73c8a98728bee">XOSD_GCWBA_GCNUM_SHIFT</a>, <a class="el" href="group__osd__v4__0.html#gaad8f1c87d9bbbfda000f872824e8300a">XOSD_GCWBA_OFFSET</a>, <a class="el" href="group__osd__v4__0.html#gaced5e2ebb0ea5479c310434321bc57ed">XOSD_GCWBA_TXT0</a>, <a class="el" href="group__osd__v4__0.html#ga5b24c90cd1ba5772581eb7b743d2abe9">XOSD_LAYER_TYPE_GPU</a>, <a class="el" href="group__osd__v4__0.html#ga09c0fe42f0cb0fe4a84e84acb6d548f3">XOsd_ReadReg</a>, and <a class="el" href="group__osd__v4__0.html#ga37791d01d7ba72baa57bd45c2744a6b7">XOsd_WriteReg</a>.</p>

</div>
</div>
<a class="anchor" id="ga282d133b39cea1c09ee62a086f8eeee8"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_x_osd___config.html">XOsd_Config</a> * XOsd_LookupConfig </td>
          <td>(</td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>DeviceId</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd_8h.html">xosd.h</a>&gt;</code></p>

<p>This function gets a reference to an <a class="el" href="struct_x_osd___config.html" title="OSD core configuration structure. ">XOsd_Config</a> structure based on the unique device id, <em>DeviceId</em>. </p>
<p>The return value will refer to an entry in the core configuration table defined in the xosd_g.c file.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">DeviceId</td><td>is the unique core ID of the OSD core for the lookup operation.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="struct_x_osd___config.html" title="OSD core configuration structure. ">XOsd_Config</a> is a reference to a config record in the configuration table (in xosd_g.c) corresponding to <em>DeviceId</em> or NULL if no match is found.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

</div>
</div>
<a class="anchor" id="ga8a5fad0300d0413161f50c5df445a08f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XOsd_SelfTest </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_osd.html">XOsd</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd_8h.html">xosd.h</a>&gt;</code></p>

<p>This function reads Version register of OSD core and compares with zero as part of self test. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_osd.html" title="The XOsd instance data. ">XOsd</a> instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>- XST_SUCCESS if the Version register read test was successful.<ul>
<li>XST_FAILURE if the Version register read test failed.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_osd___config.html#a0184842cb2ea8cc47ef55263d68d28e8">XOsd_Config::BaseAddress</a>, <a class="el" href="struct_x_osd.html#a75b2217e888eaab5cdc6b94015920bcf">XOsd::Config</a>, <a class="el" href="group__osd__v4__0.html#ga09c0fe42f0cb0fe4a84e84acb6d548f3">XOsd_ReadReg</a>, and <a class="el" href="group__osd__v4__0.html#ga36e95c1f63aa950517fb1f08a588ca01">XOSD_VER_OFFSET</a>.</p>

</div>
</div>
<a class="anchor" id="ga5552532bfdfcd272722180e71d6c7b75"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XOsd_SetActiveBank </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_osd.html">XOsd</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8&#160;</td>
          <td class="paramname"><em>GcIndex</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8&#160;</td>
          <td class="paramname"><em>ColorBankIndex</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8&#160;</td>
          <td class="paramname"><em>CharBankIndex</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8&#160;</td>
          <td class="paramname"><em>TextBankIndex</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8&#160;</td>
          <td class="paramname"><em>InstructionBankIndex</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd_8c.html">xosd.c</a>&gt;</code></p>

<p>This function chooses active banks for a GC in the OSD core. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_osd.html" title="The XOsd instance data. ">XOsd</a> instance to be worked on. </td></tr>
    <tr><td class="paramname">GcIndex</td><td>indicates which Graphics Controller to work on. Valid value range is from 0 to (The Number of Layers) - 1. The layer's type must be set to XOSD_LAYER_TYPE_GPU (defined in <a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>) for this function to work properly. </td></tr>
    <tr><td class="paramname">ColorBankIndex</td><td>indicates the color LUT bank to be choose as active. </td></tr>
    <tr><td class="paramname">CharBankIndex</td><td>indicates the character set bank to be chosen as active. </td></tr>
    <tr><td class="paramname">TextBankIndex</td><td>indicates the text data bank to be chosen as active. </td></tr>
    <tr><td class="paramname">InstructionBankIndex</td><td>indicates the instruction bank to be chosen as active.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_osd___config.html#a0184842cb2ea8cc47ef55263d68d28e8">XOsd_Config::BaseAddress</a>, <a class="el" href="struct_x_osd.html#a75b2217e888eaab5cdc6b94015920bcf">XOsd::Config</a>, <a class="el" href="struct_x_osd.html#a38a8bd573a3623c8d22a42c331007658">XOsd::IsReady</a>, <a class="el" href="struct_x_osd.html#a4fed4f9d4d3240f0c24524fee0b04d9c">XOsd::Layers</a>, <a class="el" href="struct_x_osd___layer.html#a013b375fa16c618f303251141a01c887">XOsd_Layer::LayerType</a>, <a class="el" href="group__osd__v4__0.html#ga45ae5aa9dfc53098d0b710623fad8872">XOSD_GC_BANK_NUM</a>, <a class="el" href="group__osd__v4__0.html#ga11a12b88b43abe8e5fca75b3b4b88ae3">XOSD_GCABA_CHR_MASK</a>, <a class="el" href="group__osd__v4__0.html#ga3ef9c844a0695a6af31f5aba5254ebdb">XOSD_GCABA_CHR_SHIFT</a>, <a class="el" href="group__osd__v4__0.html#ga2394cb98a760d2ffc447f4c6ddd67720">XOSD_GCABA_COL_MASK</a>, <a class="el" href="group__osd__v4__0.html#ga0180a6f642268480d81a2a006ce8b85a">XOSD_GCABA_COL_SHIFT</a>, <a class="el" href="group__osd__v4__0.html#ga0b67b99445f37ebb190b4bd69edc3f58">XOSD_GCABA_INS_MASK</a>, <a class="el" href="group__osd__v4__0.html#gaf8a5cab153ddb20712278001ab8bf534">XOSD_GCABA_OFFSET</a>, <a class="el" href="group__osd__v4__0.html#gaefe55dfbb30ee83089584e80d86471c7">XOSD_GCABA_TXT_MASK</a>, <a class="el" href="group__osd__v4__0.html#gaf4d8ce31dbe126d0fa8f5976c80de11d">XOSD_GCABA_TXT_SHIFT</a>, <a class="el" href="group__osd__v4__0.html#ga5b24c90cd1ba5772581eb7b743d2abe9">XOSD_LAYER_TYPE_GPU</a>, <a class="el" href="group__osd__v4__0.html#ga09c0fe42f0cb0fe4a84e84acb6d548f3">XOsd_ReadReg</a>, and <a class="el" href="group__osd__v4__0.html#ga37791d01d7ba72baa57bd45c2744a6b7">XOsd_WriteReg</a>.</p>

</div>
</div>
<a class="anchor" id="ga037810c3a4ef79dba6cc202afc679373"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XOsd_SetActiveSize </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_osd.html">XOsd</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>Width</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>Height</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd_8c.html">xosd.c</a>&gt;</code></p>

<p>This function sets the screen size of the OSD Output. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_osd.html" title="The XOsd instance data. ">XOsd</a> instance to be worked on. </td></tr>
    <tr><td class="paramname">Width</td><td>defines the width of the OSD output. </td></tr>
    <tr><td class="paramname">Height</td><td>defines the height of the OSD output.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_osd___config.html#a0184842cb2ea8cc47ef55263d68d28e8">XOsd_Config::BaseAddress</a>, <a class="el" href="struct_x_osd.html#a75b2217e888eaab5cdc6b94015920bcf">XOsd::Config</a>, <a class="el" href="struct_x_osd.html#a38a8bd573a3623c8d22a42c331007658">XOsd::IsReady</a>, <a class="el" href="struct_x_osd.html#a7e460ecd0c527b2880f076e19047bd8b">XOsd::ScreenHeight</a>, <a class="el" href="struct_x_osd.html#a7d42c0e6a4f18237f33c440887bfaa99">XOsd::ScreenWidth</a>, <a class="el" href="group__osd__v4__0.html#gade3687044261450fc11f800ce9414a02">XOSD_ACTIVE_SIZE_OFFSET</a>, <a class="el" href="group__osd__v4__0.html#gac75b658316a6744fba822b9d19cdbd96">XOSD_ACTSIZE_NUM_LINE_MASK</a>, <a class="el" href="group__osd__v4__0.html#ga9ac4754b89e00ebaa197523d94c5abab">XOSD_ACTSIZE_NUM_LINE_SHIFT</a>, <a class="el" href="group__osd__v4__0.html#gaee78e03170b5d597abcdb41bb789987a">XOSD_ACTSIZE_NUM_PIXEL_MASK</a>, and <a class="el" href="group__osd__v4__0.html#ga37791d01d7ba72baa57bd45c2744a6b7">XOsd_WriteReg</a>.</p>

</div>
</div>
<a class="anchor" id="gab2040236e554455aa030814966dad413"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XOsd_SetBackgroundColor </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_osd.html">XOsd</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>Red</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>Blue</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>Green</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd_8c.html">xosd.c</a>&gt;</code></p>

<p>This function sets the background color used by the OSD output. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_osd.html" title="The XOsd instance data. ">XOsd</a> instance to be worked on. </td></tr>
    <tr><td class="paramname">Red</td><td>indicates the red value to be used in the background color. </td></tr>
    <tr><td class="paramname">Blue</td><td>indicates the blue value to be used in the background color. </td></tr>
    <tr><td class="paramname">Green</td><td>indicates the green value to be used in the background color.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_osd___config.html#a0184842cb2ea8cc47ef55263d68d28e8">XOsd_Config::BaseAddress</a>, <a class="el" href="struct_x_osd.html#a75b2217e888eaab5cdc6b94015920bcf">XOsd::Config</a>, <a class="el" href="struct_x_osd.html#a38a8bd573a3623c8d22a42c331007658">XOsd::IsReady</a>, <a class="el" href="group__osd__v4__0.html#ga05c21ad0e43e61c2a4a904d60ff59a0f">XOSD_BC0_OFFSET</a>, <a class="el" href="group__osd__v4__0.html#ga636eaade937285fa383032f1013e4007">XOSD_BC0_YG_MASK</a>, <a class="el" href="group__osd__v4__0.html#gaf595fa566ff6e43a0b68207b87ae934b">XOSD_BC1_OFFSET</a>, <a class="el" href="group__osd__v4__0.html#gadbc74a40e404c4500625c304f6038eb8">XOSD_BC1_UCBB_MASK</a>, <a class="el" href="group__osd__v4__0.html#ga9196d5680140ee807654c6cfc14f8319">XOSD_BC2_OFFSET</a>, <a class="el" href="group__osd__v4__0.html#ga5ea983e4b594d372821939b55c4f1ec3">XOSD_BC2_VCRR_MASK</a>, and <a class="el" href="group__osd__v4__0.html#ga37791d01d7ba72baa57bd45c2744a6b7">XOsd_WriteReg</a>.</p>

</div>
</div>
<a class="anchor" id="ga3d389873d919422ef5f5d56592659481"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XOsd_SetCallBack </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_osd.html">XOsd</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>HandlerType</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>CallBackFunc</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>CallBackRef</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd_8h.html">xosd.h</a>&gt;</code></p>

<p>This routine installs an asynchronous callback function for the given HandlerType: </p>
<pre>
HandlerType              Callback Function Type
-----------------------  -------------------------------
XOSD_HANDLER_PROCSTART   StubCallBack
XOSD_HANDLER_FRAMEDONE   StubCallBack
XOSD_HANDLER_ERROR       StubErrCallBack</pre><pre></pre><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_osd.html" title="The XOsd instance data. ">XOsd</a> instance to be worked on. </td></tr>
    <tr><td class="paramname">HandlerType</td><td>specifies which callback is to be attached. </td></tr>
    <tr><td class="paramname">CallBackFunc</td><td>is the address of the callback function. </td></tr>
    <tr><td class="paramname">CallBackRef</td><td>is a user data item that will be passed to the callback function when it is invoked.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>- XST_SUCCESS when handler is installed.<ul>
<li>XST_INVALID_PARAM when HandlerType is invalid.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>Invoking this function for a handler that already has been installed replaces it with the new handler. </dd></dl>

<p>References <a class="el" href="struct_x_osd.html#a11b8f2d180fd2d92b6c7629926e651fd">XOsd::ErrCallBack</a>, <a class="el" href="struct_x_osd.html#ac3de9ffdd6fe3b4e30f91f1d3f3637a6">XOsd::ErrRef</a>, <a class="el" href="struct_x_osd.html#a2172512b6169dc40a5cd2c015f8e1554">XOsd::FrameDoneCallBack</a>, <a class="el" href="struct_x_osd.html#a72e3b090dd5dfc03ec61e95d347b81b8">XOsd::FrameDoneRef</a>, <a class="el" href="struct_x_osd.html#a38a8bd573a3623c8d22a42c331007658">XOsd::IsReady</a>, <a class="el" href="struct_x_osd.html#ae55843d9b4871ac1061849f7fcb5d600">XOsd::ProcStartCallBack</a>, <a class="el" href="struct_x_osd.html#abc97cc4c250059d23a8375f539a7718d">XOsd::ProcStartRef</a>, <a class="el" href="group__osd__v4__0.html#gga06fc87d81c62e9abb8790b6e5713c55bafe9b918732108caa970d83f22fceecfc">XOSD_HANDLER_ERROR</a>, <a class="el" href="group__osd__v4__0.html#gga06fc87d81c62e9abb8790b6e5713c55bac2aa1b96540765ad7b91aad694e3072b">XOSD_HANDLER_FRAMEDONE</a>, and <a class="el" href="group__osd__v4__0.html#gga06fc87d81c62e9abb8790b6e5713c55ba41c52bbf34e031cfb024cb0b21e7a212">XOSD_HANDLER_PROCSTART</a>.</p>

</div>
</div>
<a class="anchor" id="ga08b6809a1bd0d27dd275e06fe1cbea61"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XOsd_SetLayerAlpha </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_osd.html">XOsd</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8&#160;</td>
          <td class="paramname"><em>LayerIndex</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>GlobalAlphaEnable</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>GlobalAlphaValue</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd_8c.html">xosd.c</a>&gt;</code></p>

<p>This function sets the alpha value and mode of an OSD layer. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_osd.html" title="The XOsd instance data. ">XOsd</a> instance to be worked on. </td></tr>
    <tr><td class="paramname">LayerIndex</td><td>indicates which layer to be worked on. Valid value range is from 0 to (the number of layers implemented in the core - 1). </td></tr>
    <tr><td class="paramname">GlobalAlphaEnable</td><td>indicates whether to enable the global alpha. Use any non-0 value to enable the global alpha, and 0 to disable it. </td></tr>
    <tr><td class="paramname">GlobalAlphaValue</td><td>indicates the transparent level. 0 for 100% transparent, 255 (8bit) for 0% transparent (100% opaque). This argument will be ignored if parameter GlobalAlphaEnble has value 0.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_osd___config.html#a0184842cb2ea8cc47ef55263d68d28e8">XOsd_Config::BaseAddress</a>, <a class="el" href="struct_x_osd.html#a75b2217e888eaab5cdc6b94015920bcf">XOsd::Config</a>, <a class="el" href="struct_x_osd.html#a38a8bd573a3623c8d22a42c331007658">XOsd::IsReady</a>, <a class="el" href="struct_x_osd.html#a4fed4f9d4d3240f0c24524fee0b04d9c">XOsd::Layers</a>, <a class="el" href="struct_x_osd___layer.html#a013b375fa16c618f303251141a01c887">XOsd_Layer::LayerType</a>, <a class="el" href="group__osd__v4__0.html#gab825adfb1951ceab0492b842f71aacca">XOSD_L0C_OFFSET</a>, <a class="el" href="group__osd__v4__0.html#ga59528981053fa8883db1b0b897ca0c06">XOSD_LAYER_SIZE</a>, <a class="el" href="group__osd__v4__0.html#gaaaab169a7980313aad002f2301cd8023">XOSD_LAYER_TYPE_DISABLE</a>, <a class="el" href="group__osd__v4__0.html#gaa7a4a31d3453e33f287b1be4ac4dd866">XOSD_LXC</a>, <a class="el" href="group__osd__v4__0.html#gad95aafec82b865159f52e65949c23529">XOSD_LXC_ALPHA_MASK</a>, <a class="el" href="group__osd__v4__0.html#ga8b9042e82d8df689be0036e9ede471f2">XOSD_LXC_ALPHA_SHIFT</a>, <a class="el" href="group__osd__v4__0.html#gabe784eba2fa547d6a70591efa719dd16">XOSD_LXC_GALPHAEN_MASK</a>, <a class="el" href="group__osd__v4__0.html#ga09c0fe42f0cb0fe4a84e84acb6d548f3">XOsd_ReadReg</a>, and <a class="el" href="group__osd__v4__0.html#ga37791d01d7ba72baa57bd45c2744a6b7">XOsd_WriteReg</a>.</p>

</div>
</div>
<a class="anchor" id="ga33679ac417b6f2596c6b6b085d39a5b1"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XOsd_SetLayerDimension </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_osd.html">XOsd</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8&#160;</td>
          <td class="paramname"><em>LayerIndex</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>XStart</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>YStart</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>XSize</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>YSize</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd_8c.html">xosd.c</a>&gt;</code></p>

<p>This function sets the start position and size of an OSD layer. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_osd.html" title="The XOsd instance data. ">XOsd</a> instance to be worked on. </td></tr>
    <tr><td class="paramname">LayerIndex</td><td>indicates which layer to be worked on. Valid value range is from 0 to (the number of layers implemented in the core - 1). </td></tr>
    <tr><td class="paramname">XStart</td><td>indicates the horizontal start pixel of origin of the layer. </td></tr>
    <tr><td class="paramname">YStart</td><td>indicates the vertical start line of origin of the layer. </td></tr>
    <tr><td class="paramname">XSize</td><td>indicates the horizontal size of the layer. </td></tr>
    <tr><td class="paramname">YSize</td><td>indicates the vertical size of the layer.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_osd___config.html#a0184842cb2ea8cc47ef55263d68d28e8">XOsd_Config::BaseAddress</a>, <a class="el" href="struct_x_osd.html#a75b2217e888eaab5cdc6b94015920bcf">XOsd::Config</a>, <a class="el" href="struct_x_osd.html#a38a8bd573a3623c8d22a42c331007658">XOsd::IsReady</a>, <a class="el" href="struct_x_osd.html#a4fed4f9d4d3240f0c24524fee0b04d9c">XOsd::Layers</a>, <a class="el" href="struct_x_osd___layer.html#a013b375fa16c618f303251141a01c887">XOsd_Layer::LayerType</a>, <a class="el" href="struct_x_osd.html#a7e460ecd0c527b2880f076e19047bd8b">XOsd::ScreenHeight</a>, <a class="el" href="struct_x_osd.html#a7d42c0e6a4f18237f33c440887bfaa99">XOsd::ScreenWidth</a>, <a class="el" href="group__osd__v4__0.html#gab825adfb1951ceab0492b842f71aacca">XOSD_L0C_OFFSET</a>, <a class="el" href="group__osd__v4__0.html#ga59528981053fa8883db1b0b897ca0c06">XOSD_LAYER_SIZE</a>, <a class="el" href="group__osd__v4__0.html#gaaaab169a7980313aad002f2301cd8023">XOSD_LAYER_TYPE_DISABLE</a>, <a class="el" href="group__osd__v4__0.html#ga06bbfe6e69f2747df8d5260827f588fa">XOSD_LXP</a>, <a class="el" href="group__osd__v4__0.html#ga54711c94080d9bc076195b0747729856">XOSD_LXP_XSTART_MASK</a>, <a class="el" href="group__osd__v4__0.html#ga7c23d1cec7d28b5ac5c8632fe602bf9c">XOSD_LXP_YSTART_MASK</a>, <a class="el" href="group__osd__v4__0.html#gac828bb35053a7d8f8ecfc27766ec6703">XOSD_LXP_YSTART_SHIFT</a>, <a class="el" href="group__osd__v4__0.html#ga1679b9fa0d6170817f443a7c24c10a62">XOSD_LXS</a>, <a class="el" href="group__osd__v4__0.html#ga0ce8e4abc1669f61786c556bb496a471">XOSD_LXS_XSIZE_MASK</a>, <a class="el" href="group__osd__v4__0.html#ga1a19bab0f8bae1dbbfe591ad6338757a">XOSD_LXS_YSIZE_MASK</a>, <a class="el" href="group__osd__v4__0.html#ga3b683ef20fa0d1f9d9dfca72fe9bed28">XOSD_LXS_YSIZE_SHIFT</a>, and <a class="el" href="group__osd__v4__0.html#ga37791d01d7ba72baa57bd45c2744a6b7">XOsd_WriteReg</a>.</p>

</div>
</div>
<a class="anchor" id="gae10e5b163cf71fd385200b724d1dd560"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XOsd_SetLayerPriority </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_osd.html">XOsd</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8&#160;</td>
          <td class="paramname"><em>LayerIndex</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8&#160;</td>
          <td class="paramname"><em>Priority</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xosd_8c.html">xosd.c</a>&gt;</code></p>

<p>This function sets the priority of an OSD layer. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_osd.html" title="The XOsd instance data. ">XOsd</a> instance to be worked on. </td></tr>
    <tr><td class="paramname">LayerIndex</td><td>indicates which layer to be worked on. Valid value range is from 0 to (the number of layers implemented in the core - 1). </td></tr>
    <tr><td class="paramname">Priority</td><td>indicates the priority to be applied on the layer. Use one of XOSD_LAYER_PRIORITY_0 (the lowest priority) through XOSD_LAYER_PRIORITY_7 (the highest priority) defined in <a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_osd___config.html#a0184842cb2ea8cc47ef55263d68d28e8">XOsd_Config::BaseAddress</a>, <a class="el" href="struct_x_osd.html#a75b2217e888eaab5cdc6b94015920bcf">XOsd::Config</a>, <a class="el" href="struct_x_osd.html#a38a8bd573a3623c8d22a42c331007658">XOsd::IsReady</a>, <a class="el" href="struct_x_osd.html#a4fed4f9d4d3240f0c24524fee0b04d9c">XOsd::Layers</a>, <a class="el" href="struct_x_osd___layer.html#a013b375fa16c618f303251141a01c887">XOsd_Layer::LayerType</a>, <a class="el" href="group__osd__v4__0.html#gab825adfb1951ceab0492b842f71aacca">XOSD_L0C_OFFSET</a>, <a class="el" href="group__osd__v4__0.html#gaa7258407b41c68c30777e966937118ba">XOSD_LAYER_PRIORITY_7</a>, <a class="el" href="group__osd__v4__0.html#ga59528981053fa8883db1b0b897ca0c06">XOSD_LAYER_SIZE</a>, <a class="el" href="group__osd__v4__0.html#gaaaab169a7980313aad002f2301cd8023">XOSD_LAYER_TYPE_DISABLE</a>, <a class="el" href="group__osd__v4__0.html#gaa7a4a31d3453e33f287b1be4ac4dd866">XOSD_LXC</a>, <a class="el" href="group__osd__v4__0.html#gae1e09e803eb566221f3ad1ea9544534a">XOSD_LXC_PRIORITY_MASK</a>, <a class="el" href="group__osd__v4__0.html#ga2d7d038fb2a5bdf668dc3e39961e7644">XOSD_LXC_PRIORITY_SHIFT</a>, <a class="el" href="group__osd__v4__0.html#ga09c0fe42f0cb0fe4a84e84acb6d548f3">XOsd_ReadReg</a>, and <a class="el" href="group__osd__v4__0.html#ga37791d01d7ba72baa57bd45c2744a6b7">XOsd_WriteReg</a>.</p>

</div>
</div>
</div><!-- contents -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="footer">Copyright &copy; 2015 Xilinx Inc. All rights reserved.</li>
  </ul>
</div>
</body>
</html>
